关于结合Spring在实际工作中使用策略模式
一.背景
公司内部有一个这种需求,公司内部有一个爬虫的项目,大家都知道爬虫项目需要不停的变换IP,这样才能减少被风控的概率。有了不停变换IP的这种需求,自然而然就有了Ip代理商提供服务,然后我们要从Ip代理商拿去代理IP,这个时候就冒出了一个问题,我们需要将我们节点的公网IP添加到IP代理商的白名单中这样后续才能拿到代理IP。大家都知道一个公司用得IP代理商肯定是多家的,而每一家的IP代理商的添加白名单的方式又不一样。所以需要实现将节点的公网IP添加到代理服务商的白名单中,如果在系统中写多种if-else会显得很臃肿,不易于后续扩展,所以决定使用策略模式来实现这个需求。
二.什么是策略模式
通过上面的描述大家可能都知道了什么是策略模式,这里用一下官方介绍: 策略模式作为一种软件设计模式,指对象有某个行为,但是在不同的场景中,该行为有不同的实现算法,可以替代代码中大量的 if-else。
三.过程
3.1 定义一个添加白名单的处理接口
这个接口中包含两个方法,一个是获取策略类型的方法,另一个是具体的实现,下面附上源码
public interface AddWhiteIpConfigHandler {
/**
* 添加公网白名单
*
* @param oldPublicIp 旧的公网ip
* @param newPublicIp 新的公网ip
* @return boolean 是否添加成功
*/
boolean addWhitePublicIp(String oldPublicIp,String newPublicIp);
/**
* 获取添加公网白名单的类型
* @return AddPublicIpProxyType
*/
AddPublicIpProxyType getAddPublicIpProxyType();
}
3.2定义添加白名单枚举类型
public enum AddPublicIpProxyType {
TEST("TEST");
TEST2("TEST2")
private String proxyType;
AddPublicIpProxyType(String proxyType) {
this.proxyType = proxyType;
}
public static AddPublicIpProxyType getByName(String proxyType){
if(StringUtils.isBlank(proxyType)){
return TEST;
}
return AddPublicIpProxyType.valueOf(proxyType);
}
}
3.3实现策略接口
实现Test添加白名单策略
@Service
public class TestAddWhiteIpConfigHandler implements AddWhiteIpConfigHandler {
@Autowired
private IProxyConfigService proxyConfigService;
@Override
public boolean addWhitePublicIp(String oldPublicIp, String newPublicIp) {
System.out.println("Test策略模式实现"+oldPublicIp+":"+newPublicIp);
return true;
}
@Override
public AddPublicIpProxyType getAddPublicIpProxyType() {
return AddPublicIpProxyType.TEST;
}
}
实现Test2添加白名单策略
@Service
public class Test2AddWhiteIpConfigHandler implements AddWhiteIpConfigHandler {
@Autowired
private IProxyConfigService proxyConfigService;
@Override
public boolean addWhitePublicIp(String oldPublicIp, String newPublicIp) {
System.out.println("Test2策略模式实现");
System.out.println("Test2策略模式实现"+oldPublicIp+":"+newPublicIp);
return true;
}
@Override
public AddPublicIpProxyType getAddPublicIpProxyType() {
return AddPublicIpProxyType.TEST2;
}
}
3.4创建简单的策略工厂
我们让 AddWhiteIpProxyFactory实现 InitializingBean 接口,在 afterPropertiesSet 方法中,基于 Spring 容器将所有 AddWhiteIpConfigHandler自动注册到 ADD_WHITE_PUBLIC_IP_MAP,然后通过代理类型获取对应的处理器
@Component
public class AddWhiteIpProxyFactory implements InitializingBean, ApplicationContextAware {
//存储代理类型处理器的容器
private static final Map<AddPublicIpProxyType, AddWhiteIpConfigHandler> ADD_WHITE_PUBLIC_IP_MAP = new EnumMap<>(AddPublicIpProxyType.class);
private ApplicationContext appContext;
/**
* 根据代理类型获取对应添加方式
*
* @param addPublicIpProxyType 添加白名单类型
* @return AddWhiteIpConfigService 返回添加白名单的类型处理器
*/
public AddWhiteIpConfigHandler getHandler(AddPublicIpProxyType addPublicIpProxyType) {
return ADD_WHITE_PUBLIC_IP_MAP.get(addPublicIpProxyType);
}
@Override
public void afterPropertiesSet() {
try {
//从spring容器中获取对应的bean,并判断是否为AddWhiteIpConfigHandler的实现,添加到ADD_WHITE_PUBLIC_IP_MAP中
appContext.getBeansOfType(AddWhiteIpConfigHandler.class)
.values()
.forEach(value->ADD_WHITE_PUBLIC_IP_MAP.put(value.getAddPublicIpProxyType(),value));
} catch (BeansException e) {
LoggerHelper.error("初始化添加对象失败");
}
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) {
try {
//获取spring容器
appContext=applicationContext;
} catch (Exception exception) {
LoggerHelper.error("初始化获取spring容器失败");
}
}
}
3.5创建对外提供添加白名单能力的接口
/**
* @Author jmle
* @Date 2022/2/16 17:38
* @Version 1.0
*/
public interface AddWhiteIpService {
/**
* 添加公网白名单
* @param addPublicIpProxyType 代理类型
* @param oldPublicIp 旧的公网ip
* @param newPublicIp 新的公网ip
* @return boolean 是否添加成功
*/
boolean addWhiteIp(AddPublicIpProxyType addPublicIpProxyType, String oldPublicIp, String newPublicIp);
}
3.6实现添加白名单能力的接口
/**
* @Author jmle
* @Date 2022/2/16 17:42
* @Version 1.0
*/
@Service
public class AddWhiteIpServiceImpl implements AddWhiteIpService{
@Autowired
private AddWhiteIpProxyFactory addWhiteIpProxyFactory;
@Override
public boolean addWhiteIp(AddPublicIpProxyType addPublicIpProxyType, String oldPublicIp, String newPublicIp) {
//从工厂中获取对应处理器
AddWhiteIpConfigHandler handler = addWhiteIpProxyFactory.getHandler(addPublicIpProxyType);
return handler.addWhitePublicIp(oldPublicIp,newPublicIp);
}
}
这上面的实现实际是对底层的逻辑抽一层,业务只关注于上层,不关注于底层各个处理器的实现
3.7添加contorller
@RequestMapping("/proxy")
@RestController
public class ProxyController {
//注入添加白名单接口
@Autowired
private AddWhiteIpService addWhiteIpService;
@RequestMapping("addWhitePublicIp")
public ResultJson addWhitePublicIp(@RequestParam String oldPublicIp,@RequestParam String newPublicIp,String userName, String password) {
ResultJson resultJson = new ResultJson();
if (StringUtils.isBlank(oldPublicIp) || StringUtils.isBlank(newPublicIp)) {
resultJson.setStatusCode(ResultJson.STATUS_CODE_FAIL);
resultJson.setStatusMessage("所传公网IP为空");
return resultJson;
}
//获取代理类型
AddPublicIpProxyType proxyType = AddPublicIpProxyType.getByName(proxyConfig.getProxyType());
//调用添加白名单接口
boolean success = addWhiteIpService.addWhiteIp("TEST", oldPublicIp, newPublicIp);
if(success){
resultJson.setStatusCode(ResultJson.STATUS_CODE_SUCCESS);
resultJson.setStatusMessage("添加白名单成功");
return resultJson;
}
resultJson.setStatusCode(ResultJson.STATUS_CODE_FAIL);
resultJson.setStatusMessage("添加白名单失败");
return resultJson;
}
}
四.总结
由于不能将具体实现暴露到网上,所以各个添加白名单的方式都是使用打印来实现,自己实现的话可以修改内部的业务逻辑完成自己想要的功能。针对于这种场景使用策略模式的好处是,后续如果有新的代理商接入时,只需要新添加一个代理商枚举类型,然后新增一个添加白名单的处理器实现,不用修改上层,可以实现代码很好的扩展。冲冲冲!