quarkus依赖注入之七：生命周期回调

转x33g5p2x  于2022-04-12 转载在 其他  
字(7.7k)|赞(0)|评价(0)|浏览(621)

欢迎访问我的GitHub

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

本篇概览

  • 本篇的知识点是bean的生命周期回调：在bean生命周期的不同阶段，都可以触发自定义代码的执行
  • 触发自定义代码执行的具体方式，是用对应的注解去修饰要执行的方法，如下图所示：

  • 有两种模式可以实现生命周期回调：拦截器模式和自定义模式，接下来通过编码依次学习

拦截器模式

  • 《拦截器(Interceptor)》已详细介绍了quarkus拦截器的自定义和使用，包括以下三个步骤

  • 如果要自定义bean的生命周期回调，也是遵照上述步骤执行，接下来编码实现
  • 首先定义拦截器，名为TrackLifeCycle，就是个普通拦截器，需要用注解InterceptorBinding修饰
  1. package com.bolingcavalry.interceptor.define;
  3. import javax.interceptor.InterceptorBinding;
  4. import java.lang.annotation.ElementType;
  5. import java.lang.annotation.Retention;
  6. import java.lang.annotation.RetentionPolicy;
  7. import java.lang.annotation.Target;
  8. import static java.lang.annotation.ElementType.TYPE;
  10. @InterceptorBinding
  11. @Target({TYPE, ElementType.METHOD})
  12. @Retention(RetentionPolicy.RUNTIME)
  13. public @interface TrackLifeCycle {
  14. }
  • 然后是实现拦截器的功能，有几处要注意的地方稍后会提到
  1. package com.bolingcavalry.interceptor.impl;
  3. import com.bolingcavalry.interceptor.define.TrackLifeCycle;
  4. import io.quarkus.arc.Priority;
  5. import io.quarkus.logging.Log;
  6. import javax.annotation.PostConstruct;
  7. import javax.annotation.PreDestroy;
  8. import javax.interceptor.AroundConstruct;
  9. import javax.interceptor.Interceptor;
  10. import javax.interceptor.InvocationContext;
  12. @TrackLifeCycle
  13. @Interceptor
  14. @Priority(Interceptor.Priority.APPLICATION + 1)
  15. public class LifeCycleInterceptor {
  17.     @AroundConstruct
  18.     void execute(InvocationContext context) throws Exception {
  19.         Log.info("start AroundConstruct");
  20.         try {
  21.             context.proceed();
  22.         } catch (Exception e) {
  23.             e.printStackTrace();
  24.         }
  25.         Log.info("end AroundConstruct");
  26.     }
  28.     @PostConstruct
  29.     public void doPostConstruct(InvocationContext ctx) {
  30.         Log.info("life cycle PostConstruct");
  31.     }
  33.     @PreDestroy
  34.     public void doPreDestroy(InvocationContext ctx) {
  35.         Log.info("life cycle PreDestroy");
  36.     }
  37. }
  • 上述代码有以下几点需要注意
  1. 用注解Interceptor和TrackLifeCycle修饰，说明这是拦截器TrackLifeCycle的实现
  2. 被拦截bean实例化的时候，AroundConstruct修饰的方法execute就会被执行，这和《拦截器》一文中的AroundInvoke的用法很相似
  3. 被拦截bean创建成功后，PostConstruct修饰的方法doPostConstruct就会被执行
  4. 被拦截bean在销毁之前，PreDestroy修饰的方法doPreDestroy就会被执行
  • 接下来是使用拦截器TrackLifeCycle了，用于演示的bean如下，用TrackLifeCycle修饰，有构造方法和简单的helloWorld方法
  1. @ApplicationScoped
  2. @TrackLifeCycle
  3. public class Hello {
  5.     public Hello() {
  6.         Log.info(this.getClass().getSimpleName() + " at instance");
  7.     }
  9.     public void helloWorld() {
  10.         Log.info("Hello world!");
  11.     }
  12. }
  • 最后再写个单元测试类验证
  1. @QuarkusTest
  2. public class LifeCycleTest {
  4.     @Inject
  5.     Hello hello;
  7.     @Test
  8.     public void testLifyCycle() {
  9.         hello.helloWorld();
  10.     }
  11. }
  • 执行单元测试，控制台输出如下，可见拦截器的日志输出都符合预期
  1. 15:26:32,447 INFO  [io.quarkus] (main) Quarkus 2.7.3.Final on JVM started in 2.899s. Listening on: http://localhost:8081
  2. 15:26:32,448 INFO  [io.quarkus] (main) Profile test activated. 
  3. 15:26:32,448 INFO  [io.quarkus] (main) Installed features: [agroal, cdi, narayana-jta, resteasy, smallrye-context-propagation, vertx]
  4. 15:26:32,483 INFO  [com.bol.lif.Hello] (main) Hello_ClientProxy at instance
  5. 15:26:33,040 INFO  [com.bol.int.imp.LifeCycleInterceptor] (main) start AroundConstruct
  6. 15:26:33,040 INFO  [com.bol.lif.Hello] (main) Hello_Subclass at instance
  7. 15:26:33,040 INFO  [com.bol.int.imp.LifeCycleInterceptor] (main) end AroundConstruct
  8. 15:26:33,041 INFO  [com.bol.int.imp.LifeCycleInterceptor] (main) life cycle PostConstruct
  9. 15:26:33,041 INFO  [com.bol.lif.Hello] (main) Hello world!
  10. 15:26:33,097 INFO  [com.bol.int.imp.LifeCycleInterceptor] (main) life cycle PreDestroy
  11. 15:26:33,128 INFO  [io.quarkus] (main) Quarkus stopped in 0.075s
  • 以上就是通过拦截器制作的bean生命周期回调的全过程，接下来再看另一种方式：不用拦截器的方式

自定义模式

  • 刚才的拦截器模式有个明显问题：如果不同bean的生命周期回调有不同业务需求，该如何是好？为每个bean做一个拦截器吗？随着bean的增加会有大量拦截器，似乎不是个好的方案
  • 如果您熟悉spring，对下面的代码要改不陌生，这是来自spring官网的内容，直接在bean的方法上用PostConstruct和PreDestroy修饰，即可在bean的创建完成和销毁前被调用
  1. public class CachingMovieLister {
  3.   @PostConstruct
  4.   public void populateMovieCache() {
  5.       // populates the movie cache upon initialization...
  6.   }
  8.   @PreDestroy
  9.   public void clearMovieCache() {
  10.       // clears the movie cache upon destruction...
  11.   }
  12. }
  • 实际上，quarkus也支持上述方式，不过和拦截器相比有两个差异：
  1. 在bean的内部，只能用PostConstruct和TrackLifeCycle，不能用AroundConstruct，只有拦截器才能用AroundConstruct
  2. 在拦截器中，PostConstruct和TrackLifeCycle修饰的方法必须要有InvocationContext类型的入参，但是在bean内部则没有此要求
  • 咱们来改造Hello.java的源码，修改后如下，增加了两个方法，分别被PostConstruct和PreDestroy修饰
  1. @ApplicationScoped
  2. @TrackLifeCycle
  3. public class Hello {
  5.     public Hello() {
  6.         Log.info(this.getClass().getSimpleName() + " at instance");
  7.     }
  9.     @PostConstruct
  10.     public void doPostConstruct() {
  11.         Log.info("at doPostConstruct");
  12.     }
  14.     @PreDestroy
  15.     public void doPreDestroy() {
  16.         Log.info("at PreDestroy");
  17.     }
  19.     public void helloWorld() {
  20.         Log.info("Hello world!");
  21.     }
  22. }
  • 再次运行单元测试，控制台输出如下，可见Hello自定义的两个生命周期回调都执行了，同时原拦截器的三个回调也都正常执行
  1. 16:27:54,134 INFO  [io.quarkus] (main) Quarkus 2.7.3.Final on JVM started in 2.529s. Listening on: http://localhost:8081
  2. 16:27:54,135 INFO  [io.quarkus] (main) Profile test activated. 
  3. 16:27:54,135 INFO  [io.quarkus] (main) Installed features: [agroal, cdi, narayana-jta, resteasy, smallrye-context-propagation, vertx]
  4. 16:27:54,147 INFO  [com.bol.lif.Hello] (main) Hello_ClientProxy at instance
  5. 16:27:54,710 INFO  [com.bol.int.imp.LifeCycleInterceptor] (main) start AroundConstruct
  6. 16:27:54,711 INFO  [com.bol.lif.Hello] (main) Hello_Subclass at instance
  7. 16:27:54,711 INFO  [com.bol.int.imp.LifeCycleInterceptor] (main) end AroundConstruct
  8. 16:27:54,711 INFO  [com.bol.int.imp.LifeCycleInterceptor] (main) life cycle PostConstruct
  9. 16:27:54,712 INFO  [com.bol.lif.Hello] (main) at doPostConstruct
  10. 16:27:54,712 INFO  [com.bol.lif.Hello] (main) Hello world!
  11. 16:27:54,747 INFO  [com.bol.int.imp.LifeCycleInterceptor] (main) life cycle PreDestroy
  12. 16:27:54,747 INFO  [com.bol.lif.Hello] (main) at PreDestroy
  13. 16:27:54,765 INFO  [io.quarkus] (main) Quarkus stopped in 0.044s

dispose注解：实现销毁前自定义操作，dispose是另一种可选方案

  • 试想这样的场景：我的bean在销毁前要做自定义操作，但是如果用之前的两种方案，可能面临以下问题：
  1. 不适合修改bean的代码，bean的类可能是第三方库
  2. 也不适合修改生命周期拦截器代码，拦截器可能也是第三方库，也可能是多个bean共用，若修改会影响其他bean
  • 好在quarkus为我们提供了另一个方案，不用修改bean和拦截器的代码，用注解dispose修饰指定方法即可，接下来编码验证
  • 增加一个普通类ResourceManager.java，假设这是业务中的资源管理服务，可以打开和关闭业务资源，稍后会在配置类中将其指定为bean
  1. package com.bolingcavalry.service.impl;
  3. import io.quarkus.logging.Log;
  5. /**
  6.  * @author zq2599@gmail.com
  7.  * @Title: 资源管理类
  8.  * @Package
  9.  * @Description:
  10.  * @date 4/10/22 10:20 AM
  11.  */
  12. public class ResourceManager {
  14.     public ResourceManager () {
  15.         Log.info("create instance, " + this.getClass().getSimpleName());
  16.     }
  18.     /**
  19.      * 假设再次方法中打开资源，如网络、文件、数据库等
  20.      */
  21.     public void open() {
  22.         Log.info("open resource here");
  23.     }
  25.     /**
  26.      * 假设在此方法中关闭所有已打开的资源
  27.      */
  28.     public void closeAll() {
  29.         Log.info("close all resource here");
  30.     }
  31. }
  • 配置类SelectBeanConfiguration.java，指定了ResourceManager的生命周期是每次http请求
  1. package com.bolingcavalry.config;
  3. import com.bolingcavalry.service.impl.ResourceManager;
  4. import javax.enterprise.context.RequestScoped;
  6. public class SelectBeanConfiguration {
  8.     @RequestScoped
  9.     public ResourceManager getResourceManager() {
  10.         return new ResourceManager();
  11.     }  
  12. }
  • 再写一个web服务类ResourceManagerController.java，这里面使用了ResourceManager
  1. package com.bolingcavalry;
  3. import com.bolingcavalry.service.impl.ResourceManager;
  5. import javax.inject.Inject;
  6. import javax.ws.rs.GET;
  7. import javax.ws.rs.Path;
  8. import javax.ws.rs.Produces;
  9. import javax.ws.rs.core.MediaType;
  11. @Path("/resourcemanager")
  12. public class ResourceManagerController {
  14.     @Inject
  15.     ResourceManager resourceManager;
  17.     @GET
  18.     @Produces(MediaType.TEXT_PLAIN)
  19.     public String get() {
  20.         resourceManager.open();
  21.         return "success";
  22.     }
  23. }
  • 由于ResourceManager的生命周期是RequestScoped，因此每次请求/resourcemanager都会实例化一个ResourceManager，请求结束后再将其销毁
  • 现在，业务需求是每个ResourceManager的bean在销毁前，都要求其closeAll方法被执行
  • 重点来了，在SelectBeanConfiguration.java中新增一个方法，入参是bean，而且要用Disposes注解修饰，如此，ResourceManager类型的bean在销毁前此方法都会被执行
  1. /**
  2.  * 使用了Disposes注解后，ResourceManager类型的bean在销毁前，此方法都会执行
  3.  * @param resourceManager
  4.  */
  5. public void closeResource(@Disposes ResourceManager resourceManager) {
  6.     // 在这里可以做一些额外的操作，不需要bean参与
  7.     Log.info("do other things that bean do not care");
  9.     // 也可以执行bean的方法
  10.     resourceManager.closeAll();
  11. }
  • 最后是单元测试类DisposeTest.java，这里用了注解RepeatedTest表示重复执行，属性值为3，表示重复执行3次
  1. @QuarkusTest
  2. public class DisposeTest {
  4.     @RepeatedTest(3)
  5.     public void test() {
  6.         given()
  7.                 .when().get("/resourcemanager")
  8.                 .then()
  9.                 .statusCode(200)
  10.                 // 检查body内容
  11.                 .body(is("success"));
  12.     }
  13. }
  • 执行单元测试，控制台输出如下图，可见每次请求都有bean创建，也伴随着bean销毁，每次销毁都会执行closeResource方法，符合预期

  • 至此，生命周期回调相关的实战就完成了，希望能给您一些参考，接下来的文章会继续深入学习依赖注入相关的知识点

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

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 数据库+中间件系列
  6. DevOps系列

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://xinchen.blog.csdn.net/article/details/124114602

内容来源于网络，如有侵权，请联系作者删除！

Javaquarkus云原生java服务端java云原生

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com