HTTP接口设计及日志打印

转载

wx5c08995b28fc1 2023-07-04 13:55:52

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

一、需解决的问题

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

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

1. boolean
2. if (!isValid) return

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

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)：自定义注解，对需要进行签名验证的方法添加注解，例如：

1. @SecureValid
2. @ResponseBody
3. @RequestMapping(value = "/share/add", method = RequestMethod.POST)  
4. public
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功能

头文件声明：

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. class="true">  
6. "controllerAspect"
7.     </aop:aspectj-autoproxy>  
8. "controllerAspect" class="com.sogou.upd.passport.common.aspect.ControllerAspect"></bean>  
9.   
10. 　　<!-- 或： -->  
11.     <aop:aspectj-autoproxy>

自定义注解实现在Controller层面

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

三、Spring拦截器的实现

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

编写拦截器实现类

1. public class CostTimeInteceptor extends
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
7. long
8. "startTime", startTime);  
9. return true;  
10.     }  
11.   
12. @Override
13. public void
14. throws
15. long startTime = (Long) request.getAttribute("startTime");  
16. long
17. long
18. if
19. "[" + 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	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