xService微服务快速开发框架

XService:为组件化,快速构建微服务而生

什么是XService？

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

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

安装 & 入门

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

       
            com.javacoo.xservice
            xservice_base
            1.0.0
        

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

使用指南

XService的约定

• 请求协议公共部分

参数	类型	是否必选	描述
appKey	String	是	应用key
nonce	String	是	32位UUID随机字串
sign	String	是	签名
timestamp	Long	是	请求时间戳,防止重放攻击
transactionSn	String	是	交易流水号
parameter	Object	否	请求的业务对象

• 响应协议公共部分

参数	类型	描述
code	String	返回码，具体含有参见下文
message	String	返回消息，如错误信息
timestamp	String	响应时间
transactionSn	String	交易流水号
sign	String	签名
data	Object	返回的业务对象

• 返回码

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

code	message	说明
200	请求成功
207	频繁操作	频繁操作
400	请求参数出错	终端传递的参数值错误
403	没有权限	没有权限
404	服务不存在	服务不存在
408	请求超时	请求超时
409	业务逻辑出错	服务端执行服务方法时 执行业务逻辑校验出错,或者响应数据为空。
500	系统繁忙,请稍后再试	数据不满足提交条件或 服务端执行服务方法时出现异常，需由服务人员解决

• 签名/验签

签名算法：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

/**
   * 业务参数控制器基类
 * 
说明:
   * 
定义有业务参数的接口处理基本流程
   * @author DuanYong
   * @param 
 参数
   * @since 2017年6月28日下午2:48:27
   */
  @Slf4j
  public abstract class AbstractParamController
 extends BaseController {
    /**
     * 接口处理
     * 
说明:
     * 
1:请求参数解析
     * 
2:检查请求参数
     * 
3:业务处理
     * 
4:设置响应数据
     * @author DuanYong
     * @since 2017年6月28日下午3:19:43
       * @param response 响应对象
     */
    @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());
    }
    /**
     * 执行
     * 
说明:
     * 
hystrix
     * @author DuanYong
       * @since 2017年11月13日下午3:41:04
     * @param p 业务参数
       * @return: java.lang.Object 业务返回对象
     */
    private final Object execute(P p){
        return executeFunction.apply(p);
    }
    /**
     * 解析请求参数
     * 
说明:
     * 
将请求参数中的业务参数对象转换为服务使用的对象
     * @author DuanYong
     * @since 2017年6月28日下午3:17:32
       * @return: java.util.Optional
 业务参数对象
     */
    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));
        }
    }
    /**
     * 初始化初始请求参数
     * 
说明:
     * 
解析并初始化请求参数对象
     * @author DuanYong
     * @param paramString 参数原始json字符串
       * @param baseRequest 请求参数对象
     * @return P 业务参数对象
     * @since 2017年11月14日上午11:07:19
     */
    private P initBaseParameter(String paramString, BaseRequest baseRequest){
        P p = FastJsonUtil.toBean(paramString,getParamClass());
        p.setTransactionSn(baseRequest.getTransactionSn());
        p.setQueryStringMap(baseRequest.getQueryStringMap());
        return p;
    }
    /**
     * 校验请求中的业务参数
     * 
说明:
     * 
由子类实现，如果参数检查不通过，请抛出参数异常:IllegalParameterException
     * @author DuanYong
     * @param p 业务参数对象
     * @throws IllegalParameterException
     * @since 2017年6月28日下午2:28:10
     */
    protected abstract void validate(P p) throws IllegalParameterException;
    /**
     * 具体业务处理
     * 
说明:
     * 
由子类实现
     * @author DuanYong
     * @param p 业务参数对象
     * @return 业务返回数据
     * @since 2017年5月5日下午3:24:09
     */
    protected abstract Object process(P p);
    /**
     * 获取参数类型
     * 
说明:
     * 

     * @author DuanYong
     * @return 参数类型对象
     * @since 2017年7月24日上午10:33:30
     */
    protected abstract Class
 getParamClass();
    /**
     * 服务降级，默认返回REQUEST_TIMEOUT字符串，框架统一处理抛出TimeoutException异常
     * 
说明:
     * 
注意：在fallback方法中不允许有远程方法调用，方法尽量要轻，调用其他外部接口也要进行hystrix降级。否则执行fallback方法会抛出异常
     * @author DuanYong
     * @param p 参数
     * @return REQUEST_TIMEOUT
     * @since 2018年8月21日上午11:20:37
     */
    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

/**
 * 无业务参数控制器基类
 * 
说明:
 * 
定义无业务参数接口处理基本流程
 * 
统一异常处理
 * @author DuanYong
 * @since 2017年7月11日上午8:49:58
 */
@Slf4j
public abstract class AbstractNonParamController extends BaseController {
    /**
     * 具体业务处理
     * 
说明:
     * 
由子类实现
     * @author DuanYong
     * @return 业务返回数据
     * @since 2017年7月11日上午8:51:23
     */
    protected abstract Object process();
  /**
   * 接口处理
   * 
说明:
   * 
业务处理
   * 
设置响应数据
   * @since 2017年7月11日上午9:13:28
   */
  @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());
  }
  /**
   * 执行
   * 
说明:
   * @author DuanYong
   * @return: java.lang.Object 业务返回数据
   * @since 2017年11月13日下午3:41:04
   */
  private final Object execute(){
      return executeFunction.get();
  }
  /**
   * 执行业务处理
   */
  private Supplier