Spring-Boot基于配置按条件装Bean

背景
  
  同一个接口有多种实现,项目启动时按某种规则来选择性的启用其中一种实现,再具体一点,比如Controller初始化的时候,根据配置文件的指定的实现类前缀,来记载具体Service,不同Service使用不同的Dao和数据库。
  
  看到这里,我们会想到使用SPI机制,或Spring按条件加载Bean机制来实现,下面主要讨论后者。
  
  定义接口
  
  定义2个Service层接口:OrderService、OrderPromotionService,分别有一个方法,如下:
  
  // OrderService.java
  
  public interface OrderService {
  
  /**
  
  * 通过tid查询订单信息
  
  * @param tid 订单主键
  
  */
  
  List<Order> findByTid(Long tid);
  
  }
  
  ...
  
  // OrderPromotionService.java
  
  public interface OrderPromotionService {
  
  /**
  
  * 通过tid获取促销详情.
  
  * @param tid 订单唯一标识
  
  */
  
  默认实现
  
  分别实现上面2个接口的各自的方法,包路径:com.a.b。
  
  为达到根据规则装载不同ServiceImpl的目的,需要使用@Conditional注解,并且实现规则定义DefaultCondition。当Spring扫描到@Service注解时,会判断DefaultCondition#matches()方法,决定是否装载该ServiceImpl。
  
  DefaultCondition实现如下:
  
  // DefaultCondition.java
  
  public class DefaultCondition extends ParentCondition implements Condition {
  
  @Override
  
  public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
  
  Environment environment = conditionContext.getEnvironment();
  
  String interfaceName = getInterFaceName(annotatedTypeMetadata);
  
  String implPrefix = environment.getProperty(interfaceName);
  
  if (StringUtils.isEmpty(implPrefix)) {
  
  return true;
  
  }
  
  return Constant.DEFAULT_PREFIX.equals(implPrefix);
  
  }
  
  }
  
  ...
  
  // Constant.java
  
  public class Constant {
  
  public static final String THIRD_PARTY_PREFIX = "ThirdParty";
  
  public static final String DEFAULT_PREFIX = "Default";
  
  DefaultCondition实现了Spring的Condition接口,先通过方法ParentCondition#getInterFaceName()获取ServiceImpl实现的接口名称interfaceName,然后从配置文件中获取该接口指定的实现类的前缀implPrefix,然后判断是否为Constant.DEFAULT_PREFIX,如果是,则装载该ServiceImpl。
  
  获取接口名称的实现定义在ParentCondition类中(是自己实现的),是这里需要继承ParentCondition的原因。
  
  Service层实现
  
  // DefaultOrderServiceImpl.java
  
  @Conditional(DefaultCondition.class)
  
  @Service
  
  public class DefaultOrderServiceImpl implements OrderService {
  
  @Autowired
  
  private OrderDao orderDao;
  
  @Override
  
  public List<Order> findByTid(Long tid) {
  
  return orderDao.findByTid(tid);
  
  }
  
  }
  
  ...
  
  /**
  
  * 默认实现.
  
  */
  
  @Conditional(DefaultCondition.class)
  
  @Service
  
  public class DefaultOrderPromotionServiceImpl implements OrderPromotionService {
  
  @Autowired
  
  private OrderPromotionDao promotionDao;
  
  @Override
  
  public List<OrderPromotion> findByTid(Long tid) {
  
  Dao层实现
  
  // OrderDao.java
  
  @Repository
  
  public class OrderDao {
  
  @Autowired
  
  @Qualifier("firstJdbcTemplate")
  
  private JdbcTemplate jdbcTemplate;
  
  public List<Order> findByTid(Long tid) {
  
  // 省略...
  
  }
  
  }
  
  ...
  
  @Repository
  
  public class OrderPromotionDao {
  
  @Autowired
  
  @Qualifier("firstJdbcTemplate")
  
  private JdbcTemplate jdbcTemplate;
  
  public List<OrderPromotion> findByTid(final Long tid) {
  
  // 省略...
  
  Dao层使用的是自己的数据源,代码注入的是firstJdbcTemplate,Spring-Boot多数据源配置不是今天讨论的重点,这里不再详细说明。
  
  第三方实现
  
  这里假设上面的2个Service接口还有一种第三方的实现,包路径:com.c.d。跟默认实现类似,这里也要定义自己的ServiceImpl装载规则ThirdPartyCondition,实现如下:
  
  // ThirdPartyOrderServiceImpl.java
  
  public class ThirdPartyCondition extends ParentCondition implements Condition {
  
  @Override
  
  public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {
  
  Environment environment = conditionContext.getEnvironment();
  
  String interfaceName = getInterFaceName(annotatedTypeMetadata);
  
  String implPrefix = environment.getProperty(interfaceName);
  
  return Constant.THIRD_PARTY_PREFIX.equals(implPrefix);
  
  先获取ServiceImpl实现的接口名称interfaceName,然后从配置文件中获取该接口指定的实现类的前缀implPrefix,然后判断是否为Constant.THIRD_PARTY_PREFIX,如果是,则装载该ServiceImpl。
  
  Service层实现
  
  // ThirdPartyOrderServiceImpl.java
  
  @Conditional({ThirdPartyCondition.class})
  
  @Service
  
  public class ThirdPartyOrderServiceImpl implements OrderService {
  
  @Autowired
  
  private ThirdPartyOrderDao thirdPartyOrderDao;
  
  @Override
  
  public List<Order> findByTid(Long tid) {
  
  return thirdPartyOrderDao.findByTid(tid);
  
  }
  
  }
  
  ...
  
  //ThirdPartyOrderPromotionServiceImpl.java
  
  @Conditional(ThirdPartyCondition.class)
  
  @Service
  
  public class ThirdPartyOrderPromotionServiceImpl implements OrderPromotionService {
  
  @Autowired
  
  private ThirdPartyOrderPromotionDao thirdPartyOrderPromotionDao;
  
  @Override
  
  public List<OrderPromotion> findByTid(Long tid) {
  
  Dao层实现
  
  省略,Dao层实现使用另一个数据源,注入secondJdbcTemplate。
  
  以上分别为OrderService和OrderPromotionService提供了两种实现,如下:
  
  Service接口 Service默认实现 Service第三方实现
  
  OrderService DefaultOrderServiceImp
  
  使用Dao层OrderDao,数据源first www.michenggw.com JdbcTemplate ThirdPartyOrderServiceImpl
  
  使用Dao层ThirdPartyOrderDao,数据源secondJdbcTemplate
  
  OrderPromotionService DefaultOrderPromotionServiceImpl
  
  使用Dao层DefaultOrderPromotionServiceImpl,数据源firstJdbcTemplate ThirdPartyOrderPromotionServiceImpl
  
  使用Dao层ThirdPartyOrderPromotionDao,数据源secondJdbcTemplate
  
  配置规则
  
  ServiceImpl定义完成,装载规则也定义了,下面我们在Spring-Boot中分别指定两个类的加载对象
  
  // application.properties
  
  com.free.spring.jdbc.demo.service.OrderPromotionService=ThirdParty
  
  com.free.spring.jdbc.demo.service.OrderService=Default
  
  如上,定义了OrderPromotionService接口使用第三方的实现,OrderService接口使用默认实现
  
  下面简单的写两个Controller看一下效果。
  
  运行效果
  
  1. 数据准备
  
  为first库的2张表分别添加1条数据,如下:
  
  为second库的2张表添加数据
  
  2. Controller定义
  
  // OrderController.java
  
  @RestController
  
  @RequestMapping(www.dasheng178.com"/order")
  
  public class OrderController {
  
  @Autowired
  
  private OrderService orderService;
  
  @GetMapping("/{tid}")
  
  @ResponseBody
  
  public List<Order>www.haom178.com findByTid(@PathVariable(www.gouyiflb.cn"tid") Long tid) {
  
  return orderService.findByTid(tid);
  
  }
  
  }
  
  ...
  
  // OrderPromotionController.java
  
  @RestController
  
  @RequestMapping("/promotion")
  
  public class OrderPromotionController {
  
  @Autowired
  
  private OrderPromotionService promotionService;
  
  @GetMapping("www.gcyl159.com/ /{tid}")
  
  @ResponseBody
  
  public List<OrderPromotion> query(@PathVariable("tid") Long tid) {
  
  try {
  
  return promotionService.findByTid(tid);
  
  } catch (Exception e) {
  
  e.printStackTrace();
  
  }
  
  return null;
  
  我们通过Controller分别请求OrderService和OrderPromotionService,通过返回的数据判断是否真的实现了选择性装载ServiceImpl。
  
  然后我们分别请求上面两个接口,观察结果:
  
  OK!没问题!
  
  如果大家有更简单的方式,欢迎探讨~

原文地址:https://www.cnblogs.com/qwangxiao/p/10222282.html

时间: 2024-10-04 01:04:18

Spring-Boot基于配置按条件装Bean的相关文章

Spring boot将配置属性注入到bean类中

一.@ConfigurationProperties注解的使用 看配置文件,我的是yaml格式的配置: // file application.yml my: servers: - dev.bar.com - foo.bar.com - jiaobuchong.com 1 2 3 4 5 6 下面我要将上面的配置属性注入到一个Java Bean类中,看码: import org.springframework.boot.context.properties.ConfigurationProper

Spring Boot自动配置原理(转)

第3章 Spring Boot自动配置原理 3.1 SpringBoot的核心组件模块 首先,我们来简单统计一下SpringBoot核心工程的源码java文件数量: 我们cd到spring-boot-autoconfigure工程根目录下.执行 $ tree | grep -c .java$ 模块 java文件数 spring-boot 551 spring-boot-actuator 423 spring-boot-autoconfigure 783 spring-boot-devtools

4、Spring Boot 自动配置原理

1.4 Spring Boot 自动配置原理 简介 spring boot自动配置功能可以根据不同情况来决定spring配置应该用哪个,不应该用哪个,举个例子: Spring的JdbcTemplate是不是在Classpath里面?如果是,并且DataSource也存在,就自动配置一个JdbcTemplate的Bean Thymeleaf是不是在Classpath里面?如果是,则自动配置Thymeleaf的模板解析器.视图解析器.模板引擎 那个这个是怎么实现的呢?原因就在于它利用了Spring的

Springboot 系列(三)Spring Boot 自动配置

注意:本 Spring Boot 系列文章基于 Spring Boot 版本 v2.1.1.RELEASE 进行学习分析,版本不同可能会有细微差别. 前言 关于配置文件可以配置的内容,在 Spring Boot 官方网站已经提供了完整了配置示例和解释. 可以这么说,Spring Boot 的一大精髓就是自动配置,为开发省去了大量的配置时间,可以更快的融入业务逻辑的开发,那么自动配置是怎么实现的呢? 1. @SpringBootApplication 跟着 Spring Boot 的启动类的注解

Spring Boot 自动配置之@Conditional的使用

Spring Boot自动配置的"魔法"是如何实现的? 转自-https://sylvanassun.github.io/2018/01/08/2018-01-08-spring_boot_auto_configure/ Spring Boot是Spring旗下众多的子项目之一,其理念是约定优于配置,它通过实现了自动配置(大多数用户平时习惯设置的配置作为默认配置)的功能来为用户快速构建出标准化的应用.Spring Boot的特点可以概述为如下几点: 内置了嵌入式的Tomcat.Jett

Spring Boot常用配置

概述 本文主要写了下Spring Boot的一些常用配置. Spring Boot基本配置 入口类: Spring Boot通常有一个名为*Application的入口类,入口类里面有一个main方法,这个main方法其实就是一个标准的Java应用的入口方法.在main方法中使用SpringApplication.run(*Application.class, args),启动Spring Boot应用项目. @SpringBootApplication: @SpringBootApplicat

玩转spring boot——properties配置

前言 在以往的java开发中,程序员最怕大量的配置,是因为配置一多就不好统一管理,经常出现找不到配置的情况.而项目中,从开发测试环境到生产环境,往往需要切换不同的配置,如测试数据库连接换成生产数据库连接,若有一处配错或遗漏,就会带来不可挽回的损失.正因为这样,spring boot给出了非常理想的解决方案——application.properties.见application-properties的官方文档:http://docs.spring.io/spring-boot/docs/curr

Spring Boot 属性配置和使用

spring Boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码,简单说就是可以通过配置文件来注入属性或者修改默认的配置. Spring Boot 系列 Spring Boot 入门 Spring Boot 属性配置和使用 Spring Boot 集成MyBatis Spring Boot 静态资源处理 Spring Boot - 配置排序依赖技巧 Spring Boot - DevTools 介绍 Spring Boot 支持多种外部配置方式 这些方式优先级如下: 命令行参数 来

Spring Boot 属性配置和使用(转)

Spring Boot 属性配置和使用 Spring Boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码,简单说就是可以通过配置文件来注入属性或者修改默认的配置. Spring Boot 入门 请看:http://blog.csdn.net/isea533/article/details/50278205 Spring Boot 支持多种外部配置方式 这些方式优先级如下: 命令行参数 来自java:comp/env的JNDI属性 Java系统属性(System.getPropert