用Java创建类似DSL的API（并修复Builder模式）

最新推荐文章于 2024-05-22 12:43:45 发布

cunxiedian8614

最新推荐文章于 2024-05-22 12:43:45 发布

阅读量348

点赞数

文章标签： java

本文探讨了如何在Java中创建类似DSL的API，特别是在处理复杂配置时。指出传统Builder模式的不足，提出了将建造者拆分为一系列相互链接接口的解决方案。通过示例展示了一个简化版的HTTP请求构建器，强调了这种做法如何确保对象完整构建，增强代码可读性和引导用户完成构建过程。整个API设计得当，可以形成强大的DSL体验。

摘要由CSDN通过智能技术生成

在许多情况下，Java DSL只是一种组装一些复杂配置，然后将构建的结构传递给将对其进行处理的内部方法的方法。例如，SQL查询构建器，HTTP请求构建器都属于此类。

首先，简单建造者在这种情况下，模式很少方便。它对调用顺序没有限制，并且可能会导致配置不完整或仅导致代码不可读。

解决方案是拆分建造者进入相互链接的一组接口。

为了说明这种方法，让我们想象一下，我们正在尝试编写另一个非常简单的HTTP请求构建器。使用所描述的方法，它可能看起来像这样：

public interface RequestBuilder {
    static Stage1 get(String uri) {
        return new Builder(Method.GET, uri, list());
    }

    interface Stage1 {
        default Stage2 withoutParameters(Object... parameters) {
            return with();
        }

        Stage2 with(Object... parameters);
    }

    interface Stage2 {
        Request build();
    }

    class Builder implements Stage1, Stage2 {
        private final Method method;
        private final String uri;
        private final List<?> parameters;

        private Builder(final Method method, final String uri, final List<?> parameters) {
            this.method = method;
            this.uri = uri;
            this.parameters = parameters;
        }

        @Override
        public Stage2 with(final Object... parameters) {
            return new Builder(method, uri, list(parameters));
        }

        @Override
        public Request build() {
            return new Request(method, uri, parameters);
        }
    }
}

建筑规范集中在建造者类。此实现使用不可变的实例，但这不是严格必需的。

整体建造者类永远不会直接暴露给用户代码。相反，我们返回的界面将用户操作限制为with（）和没有参数（）。这些方法依次返回下一个构建阶段接口（第二阶段），允许用户完成建筑对象。

示例代码的用法如下所示。请注意，没有办法不明确指定参数（或缺少参数）：

...
RequestBuilder.get("http://somewhere.com/api/users/{param1}")
              .with(userId1)
              .build();
...
RequestBuilder.get("http://somewhere.com/api/users")
              .withoutParameters()
              .build();
...