自定义Java Exception优化：Builder模式是否适用？

当前我实现的NoSuchTaskException继承自BaseImpactException，包含多个构造方法，实际使用时需要传入大量null参数，可读性极差，例如：

• throw new NoSuchTaskException(taskId, null, isUserPresent ? null : addedById, null, null);
• throw new NoSuchTaskException(taskId, taskType.name(), taskExecutorId, null, null);

因此我计划采用Builder模式重构该异常类，重构后的代码及使用示例如下：

public class NoSuchTaskException extends BaseImpactException {
    private final String taskId;
    private final String taskType;
    private final Long userId;
    private final DocumentType documentType;
    private final Long documentId;

    private NoSuchTaskException(Builder builder) {
        super("exception.task.noSuchTask", builder.throwable);
        this.taskId = builder.taskId;
        this.taskType = builder.taskType;
        this.userId = builder.userId;
        this.documentType = builder.documentType;
        this.documentId = builder.documentId;
    }

    public static Builder builder(String taskId) {
        return new Builder(taskId);
    }
    
    @RequiredArgsConstructor
    public static class Builder {
        private String taskId;
        private String taskType;
        private Long userId;
        private DocumentType documentType;
        private Long documentId;
        private Throwable throwable;

        public Builder taskId(String taskId) {
            this.taskId = taskId;
            return this;
        }

        public Builder taskType(String taskType) {
            this.taskType = taskType;
            return this;
        }

        public Builder userId(Long userId) {
            this.userId = userId;
            return this;
        }

        public Builder documentType(DocumentType documentType) {
            this.documentType = documentType;
            return this;
        }

        public Builder documentId(Long documentId) {
            this.documentId = documentId;
            return this;
        }

        public Builder throwable(Throwable throwable) {
            this.throwable = throwable;
            return this;
        }

        public NoSuchTaskException build() {
            return new NoSuchTaskException(this);
        }
    }
}

使用示例：

throw NoSuchTaskException.builder("task123")
    .documentType(DocumentType.DOCUMENT_B)
    .documentId(500L)
    .build();

想请教这种方案是否可行？在Exception中使用Builder模式是否属于过度设计，甚至是代码异味？

你的方案完全可行，而且是解决多参数异常构造可读性问题的合理选择，绝非过度设计或代码异味。

为什么这个方案合理？ #

1. 解决核心痛点：原有的构造方法需要传递大量null，不仅可读性差，还容易因参数顺序错误导致隐藏bug。Builder模式通过显式的方法名指定参数，让代码意图一目了然，比如.documentType(DocumentType.DOCUMENT_B)清晰表明了这个异常关联的文档类型，无需读者去对应构造方法的参数位置。
2. 灵活扩展：如果后续需要给异常添加新的字段，只需在Builder中新增对应的方法即可，无需修改现有构造方法，避免了构造方法膨胀的问题，符合开闭原则。
3. 强制必填参数：你的Builder通过静态builder(String taskId)方法初始化，确保了taskId这个必填参数不会被遗漏，比重载多个构造方法更能保证异常实例的完整性。

需要注意的细节 #

• Builder的线程安全性：因为异常Builder通常是在单线程环境下临时创建并使用，所以无需额外考虑线程安全问题，这一点和普通业务对象的Builder不同。
• 异常信息的初始化：确保在NoSuchTaskException的构造方法中，正确处理了父类的异常信息和throwable参数，避免遗漏异常链的传递。
• 避免过度封装：如果后续异常的字段很少变动，也可以考虑用带默认值的构造方法或静态工厂方法作为替代，但Builder模式在字段较多、可选参数多的场景下优势明显。

总结 #

在自定义异常中使用Builder模式是一种成熟的实践，尤其是当异常包含多个可选字段时，它能显著提升代码的可读性和可维护性。你的实现已经很规范，只要保证Builder的build()方法能正确构造异常实例，就可以放心使用。

内容的提问来源于stack exchange，提问作者Aleksa Majkic