Java自定义注解实现接口报文模拟

ゝ一纸荒年。 2021-06-10 20:40 585阅读 0赞

#### 实现报文模拟 ####

1、报文模拟可以采用调用第三方模拟平台实现，整一个模拟集成平台。  
2、本地创建一个代理，如fiddler等  
3、本地采用自定义注解开发一个报文模拟

#### 代码 ####

定义Mock注解：

import java.lang.annotation.*;
    
    @Target({ ElementType.METHOD})
    @Retention(RetentionPolicy.RUNTIME)
    @Inherited
    @Documented
    public @interface Mock { 
    
    	/** * @Description 模拟类型，mock的唯一标识。 * @author chenwb * @date 2020/11/12 13:34 * @return String */
    	MockTypeEnum type();
    
    	/** * @Description 模拟报文是否需要转换 * @author chenwb * @date 2020/11/12 15:33 * @return MockConverterEnum */
    	MockConverterEnum converter() default MockConverterEnum.NULL;
    
    	/** * 如果需要转换为对象，则需要传 * @return */
    	Class<?> targetClass() default Object.class;
    }

上面提到的两个枚举，模拟类型与报文转换方案：

/** * <pre>类名: MockConverterEnum</pre> * <pre>描述: 模拟报文转换枚举</pre> * <pre>版权: web_chen@163.com</pre> * <pre>日期: 2020/11/12 15:37</pre> * <pre>作者: chenwb</pre> */
    public enum MockConverterEnum { 
    
    	/** * 不做转换，直接返回，默认 * 适用于普通字符串返回 */
    	NULL,
    
    	/** * 模拟报文为json字符串，需要转为object * @see cn.com.servyou.dzswj.annotation.Mock#targetClass() */
    	JSON2OBJECT
    }
    
    
    import org.apache.commons.lang3.StringUtils;
    
    /** * <pre>类名: MockTypeEnum</pre> * <pre>描述: 模拟类型枚举</pre> * <pre>版权: web_chen@163.com</pre> * <pre>日期: 2020/11/12 15:43</pre> * <pre>作者: chenwb</pre> */
    public enum MockTypeEnum implements BaseEnum { 
    	XZLX("XZLX"),
    	DWXZLX("DWXZLX")
    	;
    	
    	private String code;
    
    	MockTypeEnum(String code) { 
    		this.code = code;
    	}
    
    	@Override
    	public String getCode() { 
    		return code;
    	}
    
    	@Override
    	public String getText() { 
    		return StringUtils.EMPTY;
    	}
    }

模拟报文的开关与模拟报文：

import org.apache.commons.lang3.StringUtils;
    import org.springframework.beans.factory.InitializingBean;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Component;
    
    import java.util.Map;
    import java.util.concurrent.ConcurrentHashMap;
    
    /** * <pre>类名: MockConfig</pre> * <pre>描述: 模拟报文配置</pre> * <pre>版权: web_chen@163.com</pre> * <pre>日期: 2020/11/12 15:36</pre> * <pre>作者: chenwb</pre> */
    @Component
    public class MockConfig implements InitializingBean { 
    
    	@Value("${mock.sbf.xzlx.transfer}")
    	private Boolean xzlxTransferSwitch;
    
    	@Value("${mock.sbf.xzlx.mock.data}")
    	private String xzlxMockData;
    
    	@Value("${mock.sbf.dwxzlx.transfer}")
    	private Boolean dwXzlxTransferSwitch;
    
    	@Value("${mock.sbf.dwxzlx.mock.data}")
    	private String dwXzlxMockData;
    
    	/** * 开关配置 */
    	private final Map<String, Boolean> mockSwitchMap = new ConcurrentHashMap<>();
    
    	/** * 模拟报文配置 */
    	private final Map<String, String> mockDataMap = new ConcurrentHashMap<>();
    
    	/** * 开关是否开启 * @param type * @return */
    	public Boolean switchIsOpen(MockTypeEnum type) { 
    		Boolean sw = mockSwitchMap.get(type.getCode());
    		return sw == null ? Boolean.FALSE : sw;
    	}
    
    	/** * 获取模拟报文 * @param type * @return */
    	public String mockData(MockTypeEnum type) { 
    		String md = mockDataMap.get(type.getCode());
    		return md == null ? StringUtils.EMPTY : md;
    	}
    
    	@Override
    	public void afterPropertiesSet() throws Exception { 
    		mockSwitchMap.put(MockTypeEnum.XZLX.getCode(), xzlxTransferSwitch);
    		mockSwitchMap.put(MockTypeEnum.DWXZLX.getCode(),dwXzlxTransferSwitch);
    
    		mockDataMap.put(MockTypeEnum.XZLX.getCode(), xzlxMockData);
    		mockDataMap.put(MockTypeEnum.DWXZLX.getCode(), dwXzlxMockData);
    	}
    }

配置文件如下：  
![在这里插入图片描述][20201112162251517.png_pic_center]  
**接下来就是最重要的切面环节：**

import org.aspectj.lang.ProceedingJoinPoint;
    import org.aspectj.lang.annotation.Around;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.reflect.MethodSignature;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import java.lang.reflect.Method;
    
    @Aspect
    @Service
    public class MockAspect { 
    
    	private final Logger LOGGER = LoggerFactory.getLogger(MockAspect.class);
    
    	@Autowired
    	private MockConfig config;
    
    	@Around(value = "@annotation(cn.com.test.annotation.Mock)")
    	public Object mock(ProceedingJoinPoint joinPoint) throws Throwable { 
    
    		try { 
    			MethodSignature ms = (MethodSignature) joinPoint.getSignature();
    			Method method = ms.getMethod();
    			Mock mock = method.getAnnotation(Mock.class);
    			if (config.switchIsOpen(mock.type())) { 
    				LOGGER.debug("模拟报文开关开启，返回模拟报文，{} - {} - {}", mock.type(), mock.converter(), mock.targetClass());
    				if (MockConverterEnum.JSON2OBJECT == mock.converter()) { 
    					return JsonUtils.toObject(config.mockData(mock.type()), mock.targetClass());
    				}
    				return config.mockData(mock.type());
    			}
    			return joinPoint.proceed();
    		} catch (Exception e) { 
    			LOGGER.error("测试环境报文模拟出现错误，继续执行...");
    			return joinPoint.proceed();
    		}
    	}
    }

**使用方法：**  
![在这里插入图片描述][20201112162623226.png_pic_center]  
在方法上加上Mock注解，同时在MockConfig中注册即可。

#### 小结 ####

1、这种方案我虽然写了，但没有用到生产级别，因为我写完之后发现对代码的侵入性还是太大了。涉及到开关和模拟报文，新增一个模拟报文需要修改MockConfig，还要新增配置项。 如果引入第三方的模拟集成平台，用restful接口根据不同type返回不同报文会更好。  
2、虽然不是很好，但是可以作为一种实践。

有什么不当之处，欢迎指出！

[20201112162251517.png_pic_center]: /images/20210518/d75605c20be04bf49a7a1bf067e6595b.png
[20201112162623226.png_pic_center]: /images/20210518/c81afd8a50734e9b9c240207a728f63c.png