HTTP接口设计及日志打印_接口请求日志设计-CSDN博客

日志记录、性能监控的三种实现方式

博客分类：
Spring

一、需解决的问题

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

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

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

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

      Xml代码   
      
    
 <mvc:interceptors>  
      <mvc:interceptor>  
             <mvc:mapping path="/connect/share/**" />  
             <mvc:mapping path="/friend/**" />  
             <mvc:mapping path="/account/get_bind" />  
             <mvc:mapping path="/account/get_associate" />  
             <bean class="com.sogou.upd.passport.web.inteceptor.IdentityAndSecureInteceptor" />  
      </mvc:interceptor>  
  </mvc:interceptors>   

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

      Java代码   
      
    
 @SecureValid  
 @ResponseBody  
 @RequestMapping(value = "/share/add", method = RequestMethod.POST)  
 public Object addShare(HttpServletRequest req, HttpServletResponse res,InfoAPIRequestParams requestParams) {  
 　　　　...  
 }  

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

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

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

实现方式	优点	缺点
Origin	不采用反射机制，性能最佳	逻辑复杂时，代码复用不好需要在每个接口里写入相同代码（我太懒，就想写几个字母）
Spring Inter	非常适合对所有方法进行拦截，例如调试时打印所有方法执行时间类似过滤器的功能，如日志处理、编码转换、权限检查是AOP的子功能	不采用反射机制，性能有所影响需要在xml文件里配置对哪些接口进行拦截，比较麻烦
Spring AOP	使用方便，增加一个注解非常灵活，可@Before，@After，@Around等	不采用反射机制，性能有所影响（性能对比后面详细展示）

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

在Maven中加入以下以依赖：

<groupId>org.springframework</groupId>

<artifactId>spring-aop</artifactId>

<version>3.0.6.RELEASE</version>

</dependency>

<groupId>org.springframework</groupId>

<artifactId>spring-aspects</artifactId>

<version>3.0.6.RELEASE</version>

</dependency>

<groupId>org.aspectj</groupId>

<artifactId>aspectjrt</artifactId>

</dependency>

<groupId>org.aspectj</groupId>

<artifactId>aspectjweaver</artifactId>

</dependency>

<groupId>cglib</groupId>

<artifactId>cglib</artifactId>

</dependency>

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

头文件声明：

      Java代码   
      
    
 <xmlns:aop="http://www.springframework.org/schema/aop"   
 http://www.springframework.org/schema/aop   
 http://www.springframework.org/schema/aop/spring-aop-3.0.xsd  
 　　<!-- 自定义AOP -->  
     <aop:aspectj-autoproxy proxy-target-class="true">  
         <aop:include name="controllerAspect" />  
     </aop:aspectj-autoproxy>  
     <bean id="controllerAspect" class="com.sogou.upd.passport.common.aspect.ControllerAspect"></bean>  
   
 　　<!-- 或： -->  
     <aop:aspectj-autoproxy>   

自定义注解实现在Controller层面

      Java代码   
      
    
 /** 
      * 对Controller进行安全和身份校验   
      */  
     @Around("within(@org.springframework.stereotype.Controller *) && @annotation(is)")  
     public Object validIdentityAndSecure(ProceedingJoinPoint pjp, SecureValid is)  
             throws Exception {  
         Object[] args = pjp.getArgs();  
         //Controller中所有方法的参数，前两个分别为：Request,Response   
         HttpServletRequest request = (HttpServletRequest) args[0];  
           
         String appid = request.getParameter("appid");  
         int app_id = Integer.valueOf(appid);  
         String signature = request.getParameter("signature");  
         String clientSignature = request.getParameter("client_signature");  
         String uri = request.getRequestURI();  
   
         String provider = request.getParameter("provider");  
         if (StringUtils.isEmpty(provider)) {  
             provider = "passport";  
         }  
   
         // 对appid和signature进行校验  
         try {  
             appService.validateAppid(app_id);  
             boolean isValid = accountService.validSignature(app_id, signature, clientSignature);  
             if (!isValid) throw new ProblemException(ErrorUtil.ERR_CODE_COM_SING);  
         } catch (Exception e) {  
             return handleException(e, provider, uri);  
         }  
         // 继续执行接下来的代码  
         Object retVal = null;  
         try {  
             retVal = pjp.proceed();  
         } catch (Throwable e) {  
             if (e instanceof Exception) { return handleException((Exception) e, provider, uri); }  
         }  
         // 目前的接口走不到这里  
         return retVal;  
     }  

三、Spring拦截器的实现

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

编写拦截器实现类

      Java代码   
      
    
 public class CostTimeInteceptor extends HandlerInterceptorAdapter {  
   
     private static final Logger log = LoggerFactory.getLogger(CostTimeInteceptor.class);  
   
     @Override  
     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
         long startTime = System.currentTimeMillis();  
         request.setAttribute("startTime", startTime);  
         return true;  
     }  
   
     @Override  
     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,  
             ModelAndView modelAndView) throws Exception {  
         long startTime = (Long) request.getAttribute("startTime");  
         long endTime = System.currentTimeMillis();  
         long executeTime = endTime - startTime;  
         if (log.isInfoEnabled()) {  
             log.info("[" + request.getRequestURI() + "] executeTime : " + executeTime + "ms");  
         }  
     }  
 }  

四、性能对比

实验环境：对/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