1. 概述
Helidon是Oracle近期开源的全新Java微服务框架。它以J4C(Java for Cloud)的名称在Oracle项目内部使用。
在本教程中，我们将介绍框架的主要概念，然后我们将着手构建和运行基于Helidon的微服务。
2. 编程模型
目前，该框架支持两种编写微服务的编程模型：Helidon SE和Helidon MP。
Helidon SE被设计成一个支持响应式编程模型的微框架，而另一方面，Helidon MP是一个Eclipse MicroProfile运行时，它允许Jakarta EE社区以可移植的方式运行微服务。
在这两种情况下，Helidon微服务都是一个Java SE应用程序，它从main方法启动一个微型HTTP服务器。
3. Helidon SE
在本节中，我们将更详细地了解Helidon SE的主要组件：WebServer、Config和Security。
3.1 设置WebServer
要开始使用WebServer API，我们需要将所需的Maven依赖项添加到pom.xml文件中：
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver</artifactId>
<version>0.10.4</version>
</dependency>
要拥有一个简单的Web应用程序，我们可以使用以下构建器方法之一：WebServer.create(serverConfig, routing)或只是WebServer.create(routing)。后一个采用默认服务器配置，允许服务器在随机端口上运行。
下面是一个在预定义端口上运行的简单Web应用程序。我们还注册了一个简单的处理程序，它将为任何带有“/greet”路径和GET方法的HTTP请求响应问候消息：
public static void main(String... args) throws Exception {
ServerConfiguration serverConfig = ServerConfiguration.builder()
.port(9001).build();
Routing routing = Routing.builder()
.get("/greet", (request, response) -> response.send("Hello World !")).build();
WebServer.create(serverConfig, routing)
.start()
.thenAccept(ws ->
System.out.println("Server started at: http://localhost:" + ws.port())
);
}
最后一行是启动服务器并等待服务HTTP请求。但是如果我们在main方法中运行这个示例代码，我们会得到错误：
Exception in thread "main" java.lang.IllegalStateException: No implementation found for SPI: io.helidon.webserver.spi.WebServerFactory
WebServer其实就是一个SPI，我们需要提供一个运行时的实现。目前，Helidon提供了基于Netty核心的NettyWebServer实现。
这是此实现的Maven依赖项：
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver-netty</artifactId>
<version>0.10.4</version>
<scope>runtime</scope>
</dependency>
现在，我们可以运行主应用程序并通过调用配置的端点来检查它是否正常工作：
http://localhost:9001/greet
在此示例中，我们使用构建器模式配置了端口和路径。
Helidon SE还允许使用配置模式，其中配置数据由Config API提供。这是下一节的主题。
3.2 Config API
Config API提供了从配置源读取配置数据的工具。
Helidon SE为许多配置源提供了实现。默认实现由helidon-config提供，其中配置源是位于类路径下的application.properties文件：
<dependency>
<groupId>io.helidon.config</groupId>
<artifactId>helidon-config</artifactId>
<version>0.10.4</version>
</dependency>
要读取配置数据，我们只需要使用默认构建器，它默认从application.properties中获取配置数据：
Config config = Config.builder().build();
让我们在src/main/resource目录下创建一个包含以下内容的application.properties文件：
server.port=9080
web.debug=true
web.page-size=15
user.home=C:/Users/app
要读取这些值，我们可以使用Config.get()方法，然后方便地转换为相应的Java类型：
int port = config.get("server.port").asInt();
int pageSize = config.get("web.page-size").asInt();
boolean debug = config.get("web.debug").asBoolean();
String userHome = config.get("user.home").asString();
事实上，默认构建器会按以下优先顺序加载第一个找到的文件：application.yaml、application.conf、application.json和application.properties。后三种格式需要额外的相关配置依赖。例如，要使用YAML格式，我们需要添加相关的YAML配置依赖：
<dependency>
<groupId>io.helidon.config</groupId>
<artifactId>helidon-config-yaml</artifactId>
<version>0.10.4</version>
</dependency>
然后，我们添加一个application.yml：
server:
port: 9080
web:
debug: true
page-size: 15
user:
home: C:/Users/app
同样，要使用CONF(一种JSON简化格式或JSON格式)，我们需要添加helidon-config-hocon依赖项。
请注意，这些文件中的配置数据可以被环境变量和Java系统属性覆盖。
我们还可以通过禁用环境变量和系统属性或通过显式指定配置源来控制默认构建器行为：
ConfigSource configSource = ConfigSources.classpath("application.yaml").build();
Config config = Config.builder()
.disableSystemPropertiesSource()
.disableEnvironmentVariablesSource()
.sources(configSource)
.build();
除了从类路径中读取配置数据外，我们还可以使用两个外部源配置，即git和etcd配置。为此，我们需要helidon-config-git和helidon-git-etcd依赖项。
最后，如果所有这些配置源都不能满足我们的需求，Helidon允许我们为我们的配置源提供一个实现。例如，我们可以提供一个可以从数据库中读取配置数据的实现。
3.3 Routing API
Routing API提供了将HTTP请求绑定到Java方法的机制。我们可以通过使用请求方法和路径作为匹配条件或使用RequestPredicate对象来使用更多条件来完成此操作。
因此，要配置路由，我们可以只使用HTTP方法作为条件：
Routing routing = Routing.builder()
.get((request, response) -> {} );
或者我们可以将HTTP方法与请求路径结合起来：
Routing routing = Routing.builder()
.get("/path", (request, response) -> {} );
我们还可以使用RequestPredicate进行更多控制。例如，我们可以检查现有标头或内容类型：
Routing routing = Routing.builder()
.post("/save", RequestPredicate.whenRequest()
.containsHeader("header1")
.containsCookie("cookie1")
.accepts(MediaType.APPLICATION_JSON)
.containsQueryParameter("param1")
.hasContentType("application/json")
.thenApply((request, response) -> { })
.otherwise((request, response) -> { }))
.build();
到目前为止，我们已经提供了函数式风格的处理程序。我们还可以使用Service类，它允许以更复杂的方式编写处理程序。
所以，让我们首先为我们正在处理的对象Book类创建一个模型：
public class Book {
private String id;
private String name;
private String author;
private Integer pages;
// ...
}
我们可以通过实现Service.update()方法为Book类创建REST服务。这允许配置同一资源的子路径：
public class BookResource implements Service {
private BookManager bookManager = new BookManager();
@Override
public void update(Routing.Rules rules) {
rules.get("/", this::books)
.get("/{id}", this::bookById);
}
private void bookById(ServerRequest serverRequest, ServerResponse serverResponse) {
String id = serverRequest.path().param("id");
Book book = bookManager.get(id);
JsonObject jsonObject = from(book);
serverResponse.send(jsonObject);
}
private void books(ServerRequest serverRequest, ServerResponse serverResponse) {
List<Book> books = bookManager.getAll();
JsonArray jsonArray = from(books);
serverResponse.send(jsonArray);
}
// ...
}
我们还将媒体类型配置为JSON，因此我们需要helidon-webserver-json依赖项：
<dependency>
<groupId>io.helidon.webserver</groupId>
<artifactId>helidon-webserver-json</artifactId>
<version>0.10.4</version>
</dependency>
最后，我们使用Routing构建器的register()方法将根路径绑定到资源。在这种情况下，服务配置的路径以根路径为前缀：
Routing routing = Routing.builder()
.register(JsonSupport.get())
.register("/books", new BookResource())
.build();
现在我们可以启动服务器并检查端点：
http://localhost:9080/books
http://localhost:9080/books/0001-201810
3.4 Security
在本节中，我们将使用安全模块来保护我们的资源。
首先让我们声明所有必要的依赖项：
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security</artifactId>
<version>0.10.4</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-provider-http-auth</artifactId>
<version>0.10.4</version>
</dependency>
<dependency>
<groupId>io.helidon.security</groupId>
<artifactId>helidon-security-integration-webserver</artifactId>
<version>0.10.4</version>
</dependency>
helidon-security、helidon-security-provider-http-auth和helidon-security-integration-webserver依赖项可从Maven Central获得。
安全模块提供了许多用于身份验证和授权的提供程序。对于此示例，我们将使用HTTP基本身份验证提供程序，因为它相当简单，但其他提供程序的过程几乎相同。
首先要做的是创建一个Security实例。为了简单起见，我们可以以编程方式执行此操作：
Map<String, MyUser> users = // ...
UserStore store = user -> Optional.ofNullable(users.get(user));
HttpBasicAuthProvider httpBasicAuthProvider = HttpBasicAuthProvider.builder()
.realm("myRealm")
.subjectType(SubjectType.USER)
.userStore(store)
.build();
Security security = Security.builder()
.addAuthenticationProvider(httpBasicAuthProvider)
.build();
或者我们可以使用配置方法。
在这种情况下，我们将在通过Config API加载的application.yml文件中声明所有安全配置：
#Config 4 Security ==> Mapped to Security Object
security:
providers:
- http-basic-auth:
realm: "helidon"
principal-type: USER # Can be USER or SERVICE, default is USER
users:
- login: "user"
password: "user"
roles: [ "ROLE_USER" ]
- login: "admin"
password: "admin"
roles: [ "ROLE_USER", "ROLE_ADMIN" ]
#Config 4 Security Web Server Integration ==> Mapped to WebSecurity Object
web-server:
securityDefaults:
authenticate: true
paths:
- path: "/user"
methods: [ "get" ]
roles-allowed: [ "ROLE_USER", "ROLE_ADMIN" ]
- path: "/admin"
methods: [ "get" ]
roles-allowed: [ "ROLE_ADMIN" ]
要加载它，我们只需要创建一个Config对象，然后调用Security.fromConfig()方法：
Config config = Config.create();
Security security = Security.fromConfig(config);
一旦我们有了Security实例，我们首先需要使用WebSecurity.from()方法将它注册到WebServer：
Routing routing = Routing.builder()
.register(WebSecurity.from(security).securityDefaults(WebSecurity.authenticate()))
.build();
我们还可以使用配置方法直接创建一个WebSecurity实例，通过该方法我们可以加载安全和Web服务器配置：
Routing routing = Routing.builder()
.register(WebSecurity.from(config))
.build();
现在，我们可以为/user和/admin路径添加一些处理程序，启动服务器并尝试访问它们：
Routing routing = Routing.builder()
.register(WebSecurity.from(config))
.get("/user", (request, response) -> response.send("Hello, I'm Helidon SE"))
.get("/admin", (request, response) -> response.send("Hello, I'm Helidon SE"))
.build();
4. Helidon MP
Helidon MP是Eclipse MicroProfile的一个实现，还提供了一个用于运行基于MicroProfile的微服务的运行时。
由于我们已经有一篇关于Eclipse MicroProfile的文章，我们将克隆该源代码并将其修改为在Helidon MP上运行。
克隆代码后，我们将删除所有依赖项和插件，并将Helidon MP依赖项添加到POM文件中：
<dependency>
<groupId>io.helidon.microprofile.bundles</groupId>
<artifactId>helidon-microprofile-1.2</artifactId>
<version>0.10.4</version>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-json-binding</artifactId>
<version>2.26</version>
</dependency>
helidon-microprofile-1.2和jersey-media-json-binding依赖项可从Maven Central获得。
接下来，我们将在src/main/resource/META-INF目录下添加beans.xml文件，内容如下：
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
http://xmlns.jcp.org/xml/ns/javaee/beans_2_0.xsd"
version="2.0" bean-discovery-mode="annotated">
</beans>
在LibraryApplication类中，覆盖getClasses()方法，这样服务器就不会扫描资源：
@Override
public Set<Class<?>> getClasses() {
return CollectionsHelper.setOf(BookEndpoint.class);
}
最后，创建一个main方法并添加以下代码片段：
public static void main(String... args) {
Server server = Server.builder()
.addApplication(LibraryApplication.class)
.port(9080)
.build();
server.start();
}
就是这样。现在，我们将能够调用所有图书资源。
5. 总结
在本文中，我们探讨了Helidon的主要组件，还展示了如何设置Helidon SE和MP。由于Helidon MP只是一个Eclipse MicroProfile运行时，我们可以使用它运行任何现有的基于MicroProfile的微服务。
与往常一样，本教程的完整源代码可在GitHub上获得。
Post Directory
