开发总结 之 注解使用

SpringBoot 注解@ConditionalOnProperty的实战使用：

一、说明：

仅仅做一些开发过程中使用及分享，不讲原理，实战为先哈；

二、实战使用：

1.背景：

实战过程中，项目生成的接口都是空壳子，或者方便系统演示编写假逻辑去对接接口，实现类其逻辑；而真实用来实现的接口实现类是后期需要开发补上的，这时一般一个接口会对应产生两个接口实现类，比如:

// 接口
public interface GetProductInfoService {
	JSONObject getDataInfo(JSONObject data) throws Exception;
}

// 实现类1
@Service
public interface GetTrueProductInfoServiceImpl implements getProductInfoService {
	@Override
    public JSONObject getDataInfo(JSONObject data) throws Exception {
        return null;
    }
}

// 实现类2
@Service
public interface GetFakeProductInfoServiceImpl implements getProductInfoService {
	@Override
    public JSONObject getDataInfo(JSONObject data) throws Exception {
    	// 模拟处理生产的处理逻辑
        return null;
    }
}

2.问题

这种情况下，一个接口有两个实现类，那在项目运行中，如何判断其进入哪一个实现类呢？如何指定实现类呢？

3.方案：

使用其SpringBoot 注解 @ConditionalOnProperty 配合yml 文件指定其实现类执行。

4.操作：

1.将注解放在其实现类上，该接口实现的类上全部加上，方便在指定：

// 接口
public interface GetProductInfoService {
	JSONObject getDataInfo(JSONObject data) throws Exception;
}

// 实现类1
@Service
@ConditionalOnProperty(name = "GetProductInfoService.impl.BeanName", havingValue = "trueService")
public interface GetTrueProductInfoServiceImpl implements getProductInfoService {
	@Override
    public JSONObject getDataInfo(JSONObject data) throws Exception {
        return null;
    }
}

// 实现类2
@Service
@ConditionalOnProperty(name = "GetProductInfoService.impl.BeanName", havingValue = "fakeService")
public interface GetFakeProductInfoServiceImpl implements getProductInfoService {
	@Override
    public JSONObject getDataInfo(JSONObject data) throws Exception {
    	// 模拟处理生产的处理逻辑
        return null;
    }
}

2.yml 文件中指定执行的实现类：

# 启用的接口的实现类
GetProductInfoService:
  impl:
#    BeanName: fakeService
    BeanName: trueService

5.注解属性说明：

name为配置的名字；
havingValue是与配置的值对比值,当两个值相同返回true,配置类生效；

在Springboot自动配置类中，会大量出现该注解，用以控制自动配置类向Springboot中注入哪些组件。而且当Springboot如果想让自动配置类中某些组件生效，只要按照这个注解的条件在主配置类中进行配置，就能得到该组件。

6.官方说明：

https://springdoc.cn/spring-boot/