quarkus依赖注入之一：创建bean-6ren

quarkus依赖注入之一：创建bean

转载作者：知者更新时间：2024-03-13 03:25:57

欢迎访问我的GitHub

这里分类和汇总了欣宸的全部原创(含配套源码)：https://github.com/zq2599/blog_demos

关于依赖注入

对一名java程序员来说，依赖注入应该是个熟悉的概念，简单的说就是：我要用XXX，但我不负责XXX的生产
以下代码来自spring官方，serve方法要使用MyComponent类的doWork方法，但是不负责MyComponent对象的实例化，只要用注解Autowired修饰成员变量myComponent，spring环境会负责为myComponent赋值一个实例

@Service
public class MyService {
    
    @Autowired
    MyComponent myComponent;
    
    public String serve() {
        myComponent.doWork();
        return "success";
    }
}

关于依赖注入，网上有很多优秀文章，这里就不展开了，咱们要关注的是quarkus框架的依赖注入

关于《quarkus依赖注入》系列

《quarkus依赖注入》共六篇文章，整体规划上隶属于《quarkus实战》系列，但专注于依赖注入的知识点和实战
如果您熟悉spring的依赖注入，那么阅读本系列时会发现quarkus与spring之间有太多相似之处，很多地方一看就懂

本篇概览

作为《quarkus依赖注入》的开篇，本文先介绍CDI，再学习如何创建bean实例，全文内容如下
本篇内容官方提醒CDI创建bean关于CDI关于bean注解修饰在类上注解修饰在方法上注解修饰在成员变量上扩展组件中的synthetic bean
学习quarkus的依赖注入之前，来自官方的提醒非常重要

官方提醒

在使用依赖注入的时候，quankus官方建议不要使用私有变量(用默认可见性，即相同package内可见)，因为GraalVM将应用制作成二进制可执行文件时，编译器名为Substrate VM，操作私有变量需要用到反射，而GraalVM使用反射的限制，导致静态编译的文件体积增大

Quarkus is designed with Substrate VM in mind. For this reason, we encourage you to use *package-private* scope instead of *private*.

关于CDI

《 Contexts and Dependency Injection for Java 2.0》，简称CDI，该规范是对JSR-346的更新，quarkus对依赖注入的支持就是基于此规范实现的
从 2.0 版开始，CDI 面向 Java SE 和 Jakarta EE 平台，Java SE 中的 CDI 和 Jakarta EE 容器中的 CDI 共享core CDI 中定义的特性。
简单看下CDI规范的内容（请原谅欣宸的英语水平）：

该规范定义了一组强大的补充服务，有助于改进应用程序代码的结构
给有状态对象定义了生命周期，这些对象会绑定到上下文，上下文是可扩展的
复杂的、安全的依赖注入机制，还有开发和部署阶段选择依赖的能力
与Expression Language (EL)集成
装饰注入对象的能力（个人想到了AOP，你拿到的对象其实是个代理）
拦截器与对象关联的能力
事件通知模型
web会话上下文
一个SPI：允许便携式扩展与容器的集成（integrate cleanly ）

关于CDI的bean

CDI的实现（如quarkus），允许对象做这些事情：

绑定到生命周期上下文
注入
与拦截器和装饰器关联
通过触发和观察事件，以松散耦合的方式交互

上述场景的对象统称为bean，上下文中的 bean 实例称为上下文实例，上下文实例可以通过依赖注入服务注入到其他对象中
关于CDI的背景知识就介绍到这里吧，接下来要写代码了

源码下载

本篇实战的完整源码可在GitHub下载到，地址和链接信息如下表所示(https://github.com/zq2599/blog_demos)

名称	链接	备注
项目主页	https://github.com/zq2599/blog_demos	该项目在GitHub上的主页
git仓库地址(https)	https://github.com/zq2599/blog_demos.git	该项目源码的仓库地址，https协议
git仓库地址(ssh)	git@github.com:zq2599/blog_demos.git	该项目源码的仓库地址，ssh协议

这个git项目中有多个文件夹，本次实战的源码在quarkus-tutorials文件夹下，如下图红框

quarkus-tutorials是个父工程，里面有多个module，本篇实战的module是basic-di，如下图红框

创建demo工程

您可以参考《quarkus实战之二：应用的创建、构建、部署》，创建个最简单的web工程，默认生成一个web服务类HobbyResource.java，代码如下，后面的演示代码都写在这个工程中

package com.bolingcavalry;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import java.time.LocalDateTime;

@Path("/actions")
public class HobbyResource {

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {

        return "Hello RESTEasy, " + LocalDateTime.now();
    }
}

接下来，从最基础的创建bean实例创建开始

创建bean实例：注解修饰在类上

先来看看spring是如何创建bean实例的，回顾文章刚开始的那段代码，myComponent对象来自哪里？
继续看spring官方的demo，如下所示，用Component注解修饰在类上，spring就会实例化MyComponent对象并注册在bean容器中，需要用此bean的时候用Autowired注解就可以注入了

@Component
public class MyComponent {
    public void doWork() {}
}

quarkus框架下也有类似方式，演示类ClassAnnotationBean.java如下，用注解ApplicationScoped去修饰ClassAnnotationBean.类，如此quarkus就会实例化此类并放入容器中

package com.bolingcavalry.service.impl;

import javax.enterprise.context.ApplicationScoped;

@ApplicationScoped
public class ClassAnnotationBean {

    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}

这种注解修饰在类上的bean，被quarkus官方成为class-based beans
使用bean也很简单，如下，用注解Inject修饰ClassAnnotationBean类型的成员变量即可

package com.bolingcavalry;

import com.bolingcavalry.service.impl.ClassAnnotationBean;

import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import java.time.LocalDateTime;

@Path("/classannotataionbean")
public class ClassAnnotationController {

    @Inject
    ClassAnnotationBean classAnnotationBean;

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        return String.format("Hello RESTEasy, %s, %s",
                LocalDateTime.now(),
                classAnnotationBean.hello());
    }
}

如何验证上述代码是否有效？运行服务，再用浏览器访问classannotataionbean接口，肉眼判断返回内容是否符合要求，这样虽然可行，但总觉得会被嘲讽低效…
还是写一段单元测试代码吧，如下所示，注意要用QuarkusTest注解修饰测试类（不然服务启动有问题），测试方法中检查了返回码和body，如果前面的依赖注入没问题，则下面的测试应该能通过才对

package com.bolingcavalry;

import com.bolingcavalry.service.impl.ClassAnnotationBean;
import io.quarkus.test.junit.QuarkusTest;
import org.junit.jupiter.api.Test;
import static io.restassured.RestAssured.given;
import static org.hamcrest.CoreMatchers.containsString;

@QuarkusTest
class ClassAnnotationControllerTest {

    @Test
    public void testGetEndpoint() {
        given()
                .when().get("/classannotataionbean")
                .then()
                .statusCode(200)
                // 检查body内容，是否含有ClassAnnotationBean.hello方法返回的字符串
                .body(containsString("from " + ClassAnnotationBean.class.getSimpleName()));
    }
}

执行命令mvn clean test -U开始测试，控制台输出如下，提示测试通过

[INFO] Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO] 
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  5.702 s
[INFO] Finished at: 2022-03-12T15:48:45+08:00
[INFO] ------------------------------------------------------------------------

如果您的开发工具是IDEA，也可以用它的图形化工具执行测试，如下图，能得到更丰富的测试信息

掌握了最基础的实例化方式，接着看下一种方式：修饰在方法上

创建bean实例：注解修饰在方法上

下一种创建bean的方式，我们还是先看spring是怎么做的，有了它作对比，对quarkus的做法就好理解了
来看spring官方文档上的一段代码，如下所示，用Bean注解修饰myBean方法，spring框架就会执行此方法，将返回值作为bean注册到容器中，spring把这种bean的处理过程称为lite mode

@Component
 public class Calculator {
     public int sum(int a, int b) {
         return a+b;
     }

     @Bean
     public MyBean myBean() {
         return new MyBean();
     }
 }

kuarkus框架下，也能用注解修饰方法来创建bean，为了演示，先定义个普通接口

package com.bolingcavalry.service;

public interface HelloService {
    String hello();
}

以及HelloService接口的实现类

package com.bolingcavalry.service.impl;

import com.bolingcavalry.service.HelloService;

public class HelloServiceImpl implements HelloService {
    @Override
    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}

注意，HelloService.java和HelloServiceImpl.java都是普通的java接口和类，与quarkus没有任何关系
下面的代码演示了用注解修饰方法，使得quarkus调用此方法，将返回值作为bean实例注册到容器中，Produces通知quarkus做实例化，ApplicationScoped表明了bean的作用域是整个应用

package com.bolingcavalry.service.impl;

import com.bolingcavalry.service.HelloService;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Produces;

public class MethodAnnonationBean {

    @Produces
    @ApplicationScoped
    public HelloService getHelloService() {
        return new HelloServiceImpl();
    }
}

这种用于创建bean的方法，被quarkus称为producer method
看过上述代码，相信聪明的您应该明白了用这种方式创建bean的优点：在创建HelloService接口的实例时，可以控制所有细节（构造方法的参数、或者从多个HelloService实现类中选择一个），没错，在SpringBoot的Configuration类中咱们也是这样做的
前面的getHelloService方法的返回值，可以直接在业务代码中依赖注入，如下所示

package com.bolingcavalry;

import com.bolingcavalry.service.HelloService;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import java.time.LocalDateTime;

@Path("/methodannotataionbean")
public class MethodAnnotationController {

    @Inject
    HelloService helloService;

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String get() {
        return String.format("Hello RESTEasy, %s, %s",
                LocalDateTime.now(),
                helloService.hello());
    }
}

单元测试代码如下

package com.bolingcavalry;

import com.bolingcavalry.service.impl.HelloServiceImpl;
import io.quarkus.test.junit.QuarkusTest;
import org.junit.jupiter.api.Test;

import static io.restassured.RestAssured.given;
import static org.hamcrest.CoreMatchers.containsString;

@QuarkusTest
class MethodAnnotationControllerTest {

    @Test
    public void testGetEndpoint() {
        given()
                .when().get("/methodannotataionbean")
                .then()
                .statusCode(200)
                // 检查body内容，HelloServiceImpl.hello方法返回的字符串
                .body(containsString("from " + HelloServiceImpl.class.getSimpleName()));
    }
}

测试通过

producer method有个特性需要重点关注：如果刚才生产bean的getHelloService方法有个入参，如下所示，入参是OtherService对象，那么，这个OtherService对象也必须是个bean实例（这就像你用@Inject注入一个bean的时候，这个bean必须存在一样），如果OtherService不是个bean，那么应用初始化的时候会报错，（其实这个特性SpringBoot中也有，相信经验丰富的您在使用Configuration类的时候应该用到过）

public class MethodAnnonationBean {

    @Produces
    @ApplicationScoped
    public HelloService getHelloService(OtherService otherService) {
        return new HelloServiceImpl();
    }
}

quarkus还做了个简化：如果有了ApplicationScoped这样的作用域注解，那么Produces可以省略掉，写成下面这样也是正常运行的

public class MethodAnnonationBean {

    @ApplicationScoped
    public HelloService getHelloService() {
        return new HelloServiceImpl();
    }
}

创建bean实例：注解修饰在成员变量上

再来看看最后一种方式，注解在成员变量上，这个成员变量就成了bean
先写个普通类用于稍后测试

package com.bolingcavalry.service.impl;

import com.bolingcavalry.service.HelloService;

public class OtherServiceImpl {

    public String hello() {
        return "from " + this.getClass().getSimpleName();
    }
}

通过成员变量创建bean的方式如下所示，给otherServiceImpl增加两个注解，Produces通知quarkus做实例化，ApplicationScoped表明了bean的作用域是整个应用，最终OtherServiceImpl实例会被创建后注册到bean容器中

package com.bolingcavalry.service.impl;

import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Produces;

public class FieldAnnonationBean {

    @Produces
    @ApplicationScoped
    OtherServiceImpl otherServiceImpl = new OtherServiceImpl();
}

这种用于创建bean的成员变量（如上面的otherServiceImpl），被quarkus称为producer field
上述bean的使用方法如下，可见与前面的使用并无区别，都是从quarkus的依赖注入

@Path("/fieldannotataionbean")
public class FieldAnnotationController {

    @Inject
    OtherServiceImpl otherServiceImpl;

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String get() {
        return String.format("Hello RESTEasy, %s, %s",
                LocalDateTime.now(),
                otherServiceImpl.hello());
    }
}

测试代码与前面类似就不赘述了，请您自行完成编写和测试

关于synthetic bean

还有一种bean，quarkus官方称之为synthetic bean（合成bean），这种bean只会在扩展组件中用到，而咱们日常的应用开发不会涉及，synthetic bean的特点是其属性值并不来自它的类、方法、成员变量的处理，而是由扩展组件指定的，在注册syntheitc bean到quarkus容器时，常用SyntheticBeanBuildItem类去做相关操作，来看一段实例化synthetic bean的代码

@BuildStep
@Record(STATIC_INIT)
SyntheticBeanBuildItem syntheticBean(TestRecorder recorder) {
   return SyntheticBeanBuildItem.configure(Foo.class).scope(Singleton.class)
                .runtimeValue(recorder.createFoo("parameters are recorder in the bytecode")) 
                .done();
}

至此，《quarkus依赖注入》的开篇已经完成，创建bean之后还有更精彩的内容为您奉上，敬请期待

你不孤单，欣宸原创一路相伴

Java系列
Spring系列
Docker系列
kubernetes系列
数据库+中间件系列
DevOps系列

文章推荐： LeetCode_二叉树_简单_111.二叉树的最小深度

文章推荐： ThreadGroup 的 interrupt 实战

文章推荐：史上最强数据结构----双向循环链表的实现（带哨兵位）

文章推荐：设计模式之备忘录模式

quarkus - 如何读取 Quarkus 原生镜像中的类路径资源？
我已经使用将资源添加到类路径中 -H:IncludeResources=.*/kubernetes_auth.crt$ -H:Log=registerResource:verbose 当我构建图像时
quarkus - Quarkus 中哪些配置属性在部署时间/运行时不可更改？
我正在阅读 Quarkus documentation about configuration ，这引起了我的注意: Quarkus does much of its configuration an
quarkus - 如何将上下文传播到 Quarkus 中的并行流操作？
我有一系列简单的链式操作，它们使用在 Quarkus 服务中运行的 Panache 存储库检索和保存一些数据。这些操作并行化的地方是 ContextNotActiveException被抛出。在删除并
quarkus - 如何在 Quarkus 中以编程方式覆盖应用程序属性
我最近开始在我的 Quarkus 网络应用程序中使用 testcontantainers 进行单元/集成测试数据库操作。它工作正常，除了我想不出在 quarkus.datasource.url 应用程
quarkus - 如何在 Quarkus 中设置日志记录级别？
我想更改 Quarkus 应用程序的日志记录级别。如何从配置文件或在运行时执行此操作？最佳答案控制根日志记录级别的属性是 quarkus.log.level (默认为 INFO )。此属性可以
quarkus - 如何在 Quarkus 运行时更改日志级别
我正在寻找一种方法来在运行时更改 Quarkus 应用程序 (JVM) 的一个或多个类/包的日志级别。是否有我可以用来以编程方式更改级别的 API，例如通过公开 REST API 还是已经存在其他解决
quarkus - 如何调试在开发模式下运行的 Quarkus 应用程序？
我已经使用 Quarkus 开发模式 ( mvn quarkus:dev ) 启动了我的应用程序，我希望能够调试它。怎么能这样？最佳答案只需使用 mvn quarkus:dev 启动 Quark
quarkus - 在 Quarkus 中使用自定义身份提供商
在我当前的项目中，我们将用户登录信息存储在 MongoDB 集合中。我们希望实现一种身份验证机制，根据存储在所述 MongoDB 中的信息检查请求中的凭据。有一个教程可以做到这一点with JPA +
quarkus - 如何增加 Quarkus 中的事务超时？
我的 application.properties 文件中有一些配置: ... quarkus.datasource.url=jdbc:postgresql://...:5432/.... quark
quarkus - 如何以编程方式确定 Quarkus 中当前事件的配置文件
在夸库斯 Application Configuration Guide它提到了如何使用配置文件配置应用程序(例如%dev.quarkus.http.port=8181)。但是有没有办法访问配置文件
quarkus - 如何配置 Quarkus 应用程序运行的端口？
我希望我的 Quarkus 应用程序在默认端口以外的端口上运行。我怎样才能做到这一点？最佳答案要使用的 Quarkus 配置属性是 quarkus.http.port(默认值为 8080)。如果在
quarkus - 在对 Quarkus 应用程序进行单元测试时如何模拟其余客户端？
Quarkus getting started unittest描述如何模拟注入(inject)的服务。然而，当尝试将此应用于注入(inject)的休息客户端时，这似乎不起作用。在我的应用程序中，要
quarkus - Quarkus 中的 Logback 支持
我曾尝试在 Quarkus 中添加 logback，但后来发现 Quarkus 不支持 logback。如果我错了，我可以通过示例知道如何在 Quarkus 中配置 logback 吗？提前致谢。最
quarkus - 如何在测试期间覆盖 Quarkus Resteasy url？
在使用 Quarkus Restclient/RESTEasy 进行集成测试时，我们希望在运行时覆盖 url 和端口。这样做的原因是，如果我们并行构建多个模块，我们需要使用随机端口，否则我们会遇到端口
quarkus - 如何在 Quarkus 中获取 ThreadFactory？
我正在尝试将 JEE 服务迁移到 Quarkus想知道如何在 Quarkus 应用程序中获取线程工厂。只需创建一个像 javaExecutors.defaultThreadFactory();就像在
quarkus - 如何将 quarkus 中的时区设置为 UTC
我正在使用 quarkus 1.2.0。一般: 客户端浏览器向服务器请求数据。服务器(Quarkus 应用程序)正在从客户端接收 UTC 时间。 (ok) 现在服务器应该将数据库中的数据与客户端浏览
quarkus - 如何在 Quarkus 中以编程方式注册 bean？
我试图找到一种方法如何在 quarkus DI 中以编程方式创建 bean，但没有成功。在这个框架下可以吗？看来BeanManager尚未实现所需的方法。最佳答案首先，我们应该澄清“以编程方式创建
quarkus - 未使用 Quarkus 调用 aroundInvoke
我创建了以下调用类，当调用拦截的方法时，应该调用它: import javax.interceptor.AroundInvoke; import javax.interceptor.Intercept
quarkus - quarkus-maven-plugin 支持多模块项目吗？
我正在尝试将多模块 Maven 项目从普通 Java EE 8 转换为 Quarkus，并且 ArcAnnotationProcessor 似乎会抛出有关引用位于不同位置的依赖项的所有注入(injec
quarkus - 如何在 Quarkus 中使用 Jasypt 加密和解密数据库密码
我们如何在 Quarkus 中使用 jasypt 加密和解密属性文件中的数据库密码。解密将在加载或启动应用程序时发生。请分享您对此的意见或想法。 @chrisgleissner 非常感谢任何帮助。应

知者

个人简介

我是一名优秀的程序员,十分优秀！

作者热门文章

滴滴打车优惠券免费领取

全站热门文章

首页

博学

6Ren·AI

商城

quarkus依赖注入之一：创建bean

欢迎访问我的GitHub

关于依赖注入

关于《quarkus依赖注入》系列

本篇概览

官方提醒

关于CDI

关于CDI的bean

源码下载

创建demo工程

创建bean实例：注解修饰在类上

创建bean实例：注解修饰在方法上

创建bean实例：注解修饰在成员变量上

关于synthetic bean

你不孤单，欣宸原创一路相伴