HTTP接口设计及日志打印

一、需解决的问题

部分API有签名参数(signature),Passport首先对签名进行校验,校验通过才会执行实现方法。

 

第一种实现方式(Origin):在需要签名校验的接口里写校验的代码,例如:

 

Java代码   收藏代码
  1. boolean isValid = accountService.validSignature(appid, signature, client_signature);  
  2. if (!isValid) return ErrorUtil.buildError(ErrorUtil.ERR_CODE_COM_SING);  

 

 

第二种实现方式(Spring Interception):利用spring的拦截器功能,对指定的接口进行拦截,拦截器实现签名校验算法,例如:

 

Xml代码   收藏代码
  1. <mvc:interceptors>  
  2.      <mvc:interceptor>  
  3.             <mvc:mapping path="/connect/share/**" />  
  4.             <mvc:mapping path="/friend/**" />  
  5.             <mvc:mapping path="/account/get_bind" />  
  6.             <mvc:mapping path="/account/get_associate" />  
  7.             <bean class="com.sogou.upd.passport.web.inteceptor.IdentityAndSecureInteceptor" />  
  8.      </mvc:interceptor>  
  9.  </mvc:interceptors>   

 

 

第三种实现方式(spring AOP):自定义注解,对需要进行签名验证的方法添加注解,例如:

 

Java代码   收藏代码
  1. @SecureValid  
  2. @ResponseBody  
  3. @RequestMapping(value = "/share/add", method = RequestMethod.POST)  
  4. public Object addShare(HttpServletRequest req, HttpServletResponse res,InfoAPIRequestParams requestParams) {  
  5.     ...  
  6. }  

 

 

2. 日志记录功能,例如:某些接口需要记录请求和响应,执行时间,类名,方法名等日志信息。也可采用以上三种方式实现。

3. 代码性能监控问题,例如方法调用时间、次数、线程和堆栈信息等。这类问题在后一个专题提出解决方案,采用以上三种方式实现缺点太多。

 

以下是三种实现方式比较:

 

实现方式 优点 缺点
Origin

不采用反射机制,性能最佳

逻辑复杂时,代码复用不好

需要在每个接口里写入相同代码(我太懒,就想写几个字母)

Spring Inter

非常适合对所有方法进行拦截,例如调试时打印所有方法执行时间

类似过滤器的功能,如日志处理、编码转换、权限检查

是AOP的子功能

不采用反射机制,性能有所影响

需要在xml文件里配置对哪些接口进行拦截,比较麻烦

Spring AOP

使用方便,增加一个注解

非常灵活,可@Before,@After,@Around等

不采用反射机制,性能有所影响(性能对比后面详细展示)

 

 

 

二、Spring AOP 自定义注解的实现

在Maven中加入以下以依赖:

<!-- Spring AOP + AspectJ by shipengzhi -->

        <dependency>

            <groupId>org.springframework</groupId>

            <artifactId>spring-aop</artifactId>

            <version>3.0.6.RELEASE</version>

        </dependency>

        <dependency>

            <groupId>org.springframework</groupId>

            <artifactId>spring-aspects</artifactId>

            <version>3.0.6.RELEASE</version>

        </dependency>

        <dependency>

            <groupId>org.aspectj</groupId>

            <artifactId>aspectjrt</artifactId>

            <version>1.6.11</version>

        </dependency>

        <dependency>

            <groupId>org.aspectj</groupId>

            <artifactId>aspectjweaver</artifactId>

            <version>1.6.11</version>

        </dependency>

        <dependency>

            <groupId>cglib</groupId>

            <artifactId>cglib</artifactId>

            <version>2.1_3</version>

        </dependency>

        <!-- end -->

 

在spring-***.xml中加入spring支持,打开aop功能

 

头文件声明 :

Java代码   收藏代码
  1. <xmlns:aop="http://www.springframework.org/schema/aop"   
  2. http://www.springframework.org/schema/aop   
  3. http://www.springframework.org/schema/aop/spring-aop-3.0.xsd  
  4.   <!-- 自定义AOP -->  
  5.     <aop:aspectj-autoproxy proxy-target-class="true">  
  6.         <aop:include name="controllerAspect" />  
  7.     </aop:aspectj-autoproxy>  
  8.     <bean id="controllerAspect" class="com.sogou.upd.passport.common.aspect.ControllerAspect"></bean>  
  9.   
  10.   <!-- 或: -->  
  11.     <aop:aspectj-autoproxy>   

 

 

自定义注解实现在Controller层面

Java代码   收藏代码
  1. /** 
  2.      * 对Controller进行安全和身份校验   
  3.      */  
  4.     @Around("within(@org.springframework.stereotype.Controller *) && @annotation(is)")  
  5.     public Object validIdentityAndSecure(ProceedingJoinPoint pjp, SecureValid is)  
  6.             throws Exception {  
  7.         Object[] args = pjp.getArgs();  
  8.         //Controller中所有方法的参数,前两个分别为:Request,Response   
  9.         HttpServletRequest request = (HttpServletRequest) args[0];  
  10.           
  11.         String appid = request.getParameter("appid");  
  12.         int app_id = Integer.valueOf(appid);  
  13.         String signature = request.getParameter("signature");  
  14.         String clientSignature = request.getParameter("client_signature");  
  15.         String uri = request.getRequestURI();  
  16.   
  17.         String provider = request.getParameter("provider");  
  18.         if (StringUtils.isEmpty(provider)) {  
  19.             provider = "passport";  
  20.         }  
  21.   
  22.         // 对appid和signature进行校验  
  23.         try {  
  24.             appService.validateAppid(app_id);  
  25.             boolean isValid = accountService.validSignature(app_id, signature, clientSignature);  
  26.             if (!isValid) throw new ProblemException(ErrorUtil.ERR_CODE_COM_SING);  
  27.         } catch (Exception e) {  
  28.             return handleException(e, provider, uri);  
  29.         }  
  30.         // 继续执行接下来的代码  
  31.         Object retVal = null;  
  32.         try {  
  33.             retVal = pjp.proceed();  
  34.         } catch (Throwable e) {  
  35.             if (e instanceof Exception) { return handleException((Exception) e, provider, uri); }  
  36.         }  
  37.         // 目前的接口走不到这里  
  38.         return retVal;  
  39.     }  

 

 

三、Spring拦截器的实现

在spring-***.xml中加入拦截器的配置

编写拦截器实现类

Java代码   收藏代码
  1. public class CostTimeInteceptor extends HandlerInterceptorAdapter {  
  2.   
  3.     private static final Logger log = LoggerFactory.getLogger(CostTimeInteceptor.class);  
  4.   
  5.     @Override  
  6.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
  7.         long startTime = System.currentTimeMillis();  
  8.         request.setAttribute("startTime", startTime);  
  9.         return true;  
  10.     }  
  11.   
  12.     @Override  
  13.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,  
  14.             ModelAndView modelAndView) throws Exception {  
  15.         long startTime = (Long) request.getAttribute("startTime");  
  16.         long endTime = System.currentTimeMillis();  
  17.         long executeTime = endTime - startTime;  
  18.         if (log.isInfoEnabled()) {  
  19.             log.info("[" + request.getRequestURI() + "] executeTime : " + executeTime + "ms");  
  20.         }  
  21.     }  
  22. }  

 

 

 四、性能对比

 实验环境:对/account/get_associate接口,并发500,压测10分钟

指标 Origin Spring Inter Spring AOP
CPU user%:26.57

sys%:10.97

cpu%:37.541

user%:26.246

sys%:10.805

cpu%:37.051

user%:24.123

sys%:9.938

cpu%:34.062

Load 13.85 13.92  12.21 
QPS 6169 6093.2 5813.27
RT

0.242ms

0.242ms

0.235ms

采用AOP对响应时间无明显影响

采用AOP对Load无明显影响

采用AOP对CPU无明显影响

 

结论:使用AOP性能方面影响可忽略

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值