xService微服务快速开发框架

XService接口服务快速开发框架,基于SpringBoot实现，封装了接口开发过程中的基础功能及控制流程,并约定了统一的接口报文格式，制定了完善的开发规范以及测试规范，让程序员只需关注具体业务实现，提高了开发接口服务的效率。

XService基础功能基于xkernel 提供的SPI机制，结合SpringBoot提供的 ConditionalOnBean,ConditionalOnProperty等注解实现，实用，简单，扩展灵活。

如果你是使用Maven来构建项目，你需要添加XService的pom.xml文件内，如下所示：

       
			com.javacoo.xservice
			xservice_base
			1.0.0
		

添加完组件我们就可以进行配置使用了。

• 请求协议公共部分

• 响应协议公共部分

• 返回码

平台级返回码如下：业务可制定具体的业务返回代码

• 签名/验签

签名算法：HEx(SHA256(secretKey+参数字符串+随机数+时间戳+secretKey))

说明:

1:参数字符串=将报文体中 业务对象 转换为 json字符串。

2:将应用密钥(secretKey)分别添加到 参数字符串+随机数+时间戳 的头部和尾部:secretKey+参数字符串+随机数+时间戳+secretKey.

3:对该字符串进行 SHA256 运算，得到一个byte数组。

4:将该byte数组转换为十六进制的字符串，该字符串即是签名。

• 加密/解密

  加密算法：base64(DES(value,secretKey))

  解密算法：DES(base64(value),secretKey)

• 定义接口服务

  XService约定一个接口服务为一个Controller类，且此类必须继承框架提供的三个基类之一。

  带参数的接口服务基类：AbstractParamController

  @Slf4j
  public abstract class AbstractParamController
 extends baseController {
  	
  	@RequestMapping
  	public final void handle(HttpServletResponse response) {
  		final Long startTime = System.currentTimeMillis();
          //参数解析->检查请求参数->业务处理->设置响应数据
  		parse().map(r->validateFunction.apply(r)).map(r->Optional.ofNullable(execute(r))).map(o->setSuccessResponse(response,o.orElse(Optional.empty())));
          log.info("接口->{},处理完成,耗时->{}秒,流水号:{}", SwapAreaUtils.getSwapAreaData().getReqMethod(),(System.currentTimeMillis() - startTime)/1000.0,SwapAreaUtils.getSwapAreaData().getTransactionSn());
  	}
  	
  	private final Object execute(P p){
  		return executeFunction.apply(p);
  	}
  	
  	protected final Optional
 parse(){
  		baseRequest baseRequest = SwapAreaUtils.getSwapAreaData().getbaseRequest();
  		baseRequest.getParameter().orElseThrow(()->new IllegalParameterException(Resources.getMessage(ErrorCodeConstants.COMMON_REQ_PARAM_PARSE_IS_EMPTY)));
  		try{
  			return baseRequest.getParameter().map(o->o.toString()).map(s->initbaseParameter(s,baseRequest));
  		}catch(Exception ex){
  			ex.printStackTrace();
              log.error("将请求参数中的业务参数对象转换为服务使用的对象失败,流水号:{},请求参数:{},异常信息:", WebUtil.getSwapAreaData().getTransactionSn(),baseRequest.getParameter(),ex);
  			throw new IllegalParameterException(Resources.getMessage(ErrorCodeConstants.COMMON_REQ_PARAM_PARSE_ERROR));
  		}
  	}
  	
  	private P initbaseParameter(String paramString, baseRequest baseRequest){
  		P p = FastJsonUtil.toBean(paramString,getParamClass());
  		p.setTransactionSn(baseRequest.getTransactionSn());
  		p.setQueryStringMap(baseRequest.getQueryStringMap());
  		return p;
  	}
  	
  	protected abstract void validate(P p) throws IllegalParameterException;
  	
  	protected abstract Object process(P p);
  	
  	protected abstract Class
 getParamClass();
  	
  	protected Object fallback(P p){
  		return Constants.REQUEST_TIMEOUT;
  	}
  
  	
  	private Function validateFunction = (P p)->{
  		validate(p);
  		return p;
  	};
  	
  	private Function executeFunction = (P p)-> process(p);
  	
  	private Function fallbackFunction = (P p)-> fallback(p);
  }

无参数的接口服务基类：AbstractNonParamController

@Slf4j
public abstract class AbstractNonParamController extends baseController {
    
    protected abstract Object process();
	
	@RequestMapping
	private final void handle(HttpServletResponse httpServletResponse) {
		Long startTime = System.currentTimeMillis();
		//业务处理->设置响应数据
		Optional.ofNullable(execute()).map(o->setSuccessResponse(httpServletResponse,o));
		log.info("接口->{},处理完成,耗时->{}秒,流水号:{}", SwapAreaUtils.getSwapAreaData().getReqMethod(),(System.currentTimeMillis() - startTime)/1000.0,SwapAreaUtils.getSwapAreaData().getTransactionSn());
	}
	
	private final Object execute(){
		return executeFunction.get();
	}
	
	private Supplier