springAOP实现的异常日志记录+异常邮件发送+权限控制

admin

    忙里偷闲最近在看关于springAop的一些功能、顺便完善一下项目。

       一般我们的异常都会抛出到控制层，如果使用struts2也就是action。然后try{//正确代码实现}catch{//在里面记录错误日志}，这样咋一看是不错，代码很完美。但是如果项目中有成千上万个项目怎么办？难道在每个action的catch里面都要加入异常记录代码？很显然工作量是很大的。

3 _6 Q0 S! L8 N' C2 y; Y
8 C4 C# g/ ?. Y$ c; g. `       鉴于项目中配置了数据库事务，其实也是使用了AOP 详见applicationContext-service.xml配置文件。由于配置文件的局限性这里采用注释的方式实现。之所有使用注释是可以自定义参数并实现日志的详细记录。既然使用注释，现成的没有，只有自己定义来实现需求。其实spring 注释实现的注入、hibernate的model类注释实现与数据库关联以及我们最常见Override。
       资料:java如何实现自定义注释http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html
6 [6 Y& }3 K) I# R/ M
. ^% w# d  S+ o% u1 f一、 记录日志并发送邮件通知
(1)、定义注解：
. y! h- r' R2 I+ @! T+ k6 `1.ServiceLog.java(各种参数类型详见上面的资料)

1. import java.lang.annotation.*;
   
2. /**
   
3. * 自定义注解 拦截service  
   
4. * 创建者        张志朋
   + Q' L. I4 v. ^4 ~# _
5. * 创建时间        2015年6月3日
   
6. *
   ; B4 S1 p. H5 j1 \2 V' u8 Q" C
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    
11. public  @interface ServiceLog {
    2 C* ~$ ?: r/ `1 ]% q8 e
12.          String description()  default "";
    " Z5 x6 j# b* T0 Y: ^
13. }

复制代码

2.ControllerLog.java

1. import java.lang.annotation.*;
   9 W0 k" T( I8 [
2. /**
   
3. * 自定义注解 拦截Controller
   & t5 e+ @' {( a% h4 v
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   
6. *
   2 T: Q/ ^( l4 j8 X+ [- m
7. */
   $ z- _  c5 X2 a+ d6 H
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   & ]  R& @+ Y: |7 x* B
9. @Retention(RetentionPolicy.RUNTIME)   
   4 _; T, f: z, @. X5 u! z5 d
10. @Documented
    
11. public @interface ControllerLog {
    " T- j3 G+ U1 P' \* P
12.         String description()  default "";
    
13. }

复制代码

(2)、定义切面以及切入点
7 q7 r. c; |: K1 y$ C  ~3 ?& J1.LogAspect.java

1. /**
   ' r- z5 Y8 V7 s$ H* {* Y
2. * 日志记录AOP
   8 \( x+ c, _. f- d% V
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月3日
   
5. *
   . Y6 A6 C8 I) i: D
6. */
   2 D. W7 L: N0 {3 M2 W( S) T
7. @Component
   % K6 Q$ B! E9 G. q# _- E% Q
8. @Scope
   
9. @Aspect
   : z: {# S8 U1 d
10. public class LogAspect {
    
11.         //Service层切点     用于记录错误日志
    / }6 p8 Y" q- ^" W; i3 V3 a
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    
13.         public void serviceAspect() {
    9 @' h3 _/ W3 |8 U5 H: H/ C/ D
14.                
    
15.         }
    6 y! ]' n. b2 D& T5 ^
16.     /**
    
17.      * 异常通知 用于拦截service层记录异常日志  
    
18.      * @Author        张志朋
    2 H- E6 n( I6 ?3 d8 p
19.      * @param joinPoint
    
20.      * @param e  void
    
21.      * @Date        2015年6月3日
    & S8 E! {* m7 J- y2 \4 }$ N
22.      * 更新日志
    & \: I' g6 x. N- w
23.      * 2015年6月3日 张志朋  首次创建
    
24.      *
    , p8 a& e9 [% H- \) A% i
25.      */
    
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    8 d. M  F9 Y' f# [0 W
29.                 TeacherEntity user = CommonUtil.getUser();
    
30.                 String ip = AddressUtils.getIpAddr(request);
    6 {& b4 ?/ {6 S5 t2 g# f
31.                 try {
    - Y5 P: L3 c- ~. Y' Y& V% H
32.                         String params = "";
    
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    ! u& B8 x; P+ V6 I3 e
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    ; b' m! J- P3 B9 S" N1 d" x
36.                                 }
    
37.                         }
    7 J3 K2 y  k/ X; W
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    - v( S3 G2 V& K4 s; o6 v4 E
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    
42.                         /*==========记录数据库异常日志==========*/  
    
43.                         Log log = new Log();
    
44.                         log.setDescription(description);
    
45.                         log.setExceptionCode(exceptionCode);
    
46.                         log.setExceptionDetail(exceptionDetail);
    ( @8 g; S( i; j  c
47.                         log.setMethod(method);
    
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    # L4 ^- T4 Z- _5 o6 {4 N0 |4 ?
50.                         log.setParams(params);//请求参数
    
51.                         if(null!=user){
    
52.                     log.setCreateUid(user.getUid());//用户ID
    
53.                     log.setCreateName(user.getNickname());//用户昵称
    . ?/ R2 u9 {: |8 _
54.             }
    
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    : c- v# [* Z" [9 j( j
56.                         /*==========记录数本地异常日志==========*/  
    , h6 R, J# p5 W" {( O
57.                         //LogUtil.error(description, e);
    0 s- \7 e$ S( R
58.                         /*==========发送异常日志到邮箱==========*/
    
59.                         StringBuffer errorMsg = new StringBuffer();
    
60.                         errorMsg.append("异常方法:");
    
61.                         errorMsg.append(method);
    
62.                         errorMsg.append("</br>");
    " c9 m  \6 j2 a$ c: p6 k6 G/ |
63.                         errorMsg.append("异常类型代码:");
    # d, t3 Y. P5 V( i  ~8 `0 U0 t
64.                         errorMsg.append(exceptionCode);
    
65.                         errorMsg.append("</br>");
    1 g* _. J/ [; j$ a
66.                         errorMsg.append("异常详细信息:");
    
67.                         errorMsg.append(exceptionDetail);
    0 y. q: N4 U* N9 b# a4 N* F
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    
71.                         Client.sendError(log);
    * k4 F7 Z' ?; K& S; X
72.                 } catch (Exception ex) {
    1 U: s4 n7 j/ E& h! e' r" ~
73.                         e.printStackTrace();
    + G* O5 r, ?/ J2 ~5 B; ?$ }. m
74.                 }
    
75.     }
    
76.      /**
    5 N, V% s' W$ u2 ~3 p9 a& |
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    & c/ {9 o! o* _$ D: h
78.       * @Author        张志朋
    
79.       * @param joinPoint
    8 \8 P+ j2 W. d/ B8 i9 ]5 u8 \& ~
80.       * @return
    
81.       * @throws Exception  String
    
82.       * @Date        2015年6月3日
    : a, s! D6 S5 Q) C# u9 s
83.       * 更新日志
    6 ~( G$ \( x. B: |* U
84.       * 2015年6月3日 张志朋  首次创建
    3 O1 B4 Q; h' j5 l7 t5 ]6 y
85.       *
    
86.       */
    0 p; u/ {% {/ d1 _" A( Y
87.      @SuppressWarnings("rawtypes")
    : J* w8 _; k9 l/ J0 Z( B
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    9 t7 E4 n6 ]* A) H& j1 r+ j
89.              throws Exception {   
    
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    1 `( l% s: K- \5 V. S' X
91.         String methodName = joinPoint.getSignature().getName();   
    
92.         Object[] arguments = joinPoint.getArgs();   
    
93.         Class targetClass = Class.forName(targetName);   
    
94.         Method[] methods = targetClass.getMethods();   
    0 s1 `7 J; e( K! @1 |2 y$ G1 Z) p2 j
95.         String description = "";   
    
96.          for (Method method : methods) {   
    2 ?4 y& C! @0 K0 c
97.              if (method.getName().equals(methodName)) {   
    $ ^: _5 O3 M; ^* N
98.                 Class[] clazzs = method.getParameterTypes();   
    
99.                  if (clazzs.length == arguments.length) {   
    
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     9 `4 G" e  j: G; h: h& M0 L
101.                      break;   
     ! ^2 o1 P0 G7 S: J; z4 A0 h
102.                 }   
     / r/ q% A1 H6 h6 B  A8 H* s4 X' U
103.             }   
     
104.         }   
     
105.          return description;   
     
106.     }
     
107.     }

复制代码

这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
$ L+ B  N& t$ ydoAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。
7 Y- D/ Q6 G( Z7 l- [& h6 ]: {
2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）
5 y0 y6 j. _# b  ~! J5 w1 Y

1. @ServiceLog(description="获取待审试题数量")
   
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   ( X- N' Y( L5 y2 H; q7 _1 \0 q  b2 M
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   ) u+ c) e+ W5 E. G
4.         }

复制代码

- V! s5 q# z# x: e# }之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
二、AOP实现权限控制
       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
& }# U# F  D, g& ?  h% n/ i        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
$ K5 l" c5 R2 t0 m首先配置文件要引入这样一段配置(看注释说明)：

1. <!--通知spring使用cglib而不是jdk的来生成代理方法 AOP可以拦截到Controller(Action)-->
   # }# `6 |/ Q+ A1 |% V6 y5 I
2.         <aop:aspectj-autoproxy proxy-target-class="true"/>

复制代码

(1)、定义注释：
/ j. E$ i) S( o$ s8 H/ e& ?7 J1.Permission.java

1. /**
   
2. * 自定义权限管理
   * D: V0 [7 \; k% e2 H0 R6 b
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月30日
   
5. *
   
6. */
   
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
8. @Retention(RetentionPolicy.RUNTIME)   
   
9. @Documented
   # p" T( u! H  B$ f5 {/ W1 L
10. public @interface Permission {
    
11.         String name()  default ""; //操作行为
    5 G) X- T; ^% n: D! z/ [$ V- F  h
12.         int id() default -1;//权限值
    
13. }

复制代码

(2)、定义切面以及切入点
6 `* u- {0 t7 R- |- |$ g1.PsemissionAspect.java
" K+ R2 `7 ~$ z8 u4 N

1. /**
   
2. * 权限管理
   " m& X4 P  z* l
3. * 创建者        张志朋
   ; n$ V& \0 X2 s; r5 u) c7 |
4. * 创建时间        2015年7月3日
   - e6 {, X4 L) n0 b5 \
5. *
   / C/ f; d8 u( E/ w
6. */
   
7. @Component
   
8. @Scope
   + A! K9 y/ Z& X7 |3 S' w0 }
9. @Aspect
   , C8 M- S6 y8 i  \! ?
10. public class PsemissionAspect {
    
11.         
    
12.     //Controller层切点 用于权限控制
    ' b% I3 r( p5 E, K0 B
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    
14.         public void permissionAspect() {
    
15.                
    
16.         }
    7 T* ]; p$ q4 C
17.         /**
    + g. L  n9 \! G: F
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    # G4 j1 K% E! [& r8 u, m: T
19.          * @Author        张志朋
    . M6 T# C# U2 G  M1 ~- T
20.          * @param joinPoint  void
    
21.          * @Date        2015年6月3日
    4 T! _* A5 g) j/ u% N3 e9 z7 {0 E
22.          * 更新日志
    / I: K, j. m7 N
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    / F/ E! ]& g8 v, f+ ]  J# K9 g
25.          */
    
26.     @Around("permissionAspect()")   
    ! p5 |9 ^& v5 [
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    + X+ w2 q! K4 q% a6 H: p
28.         Object retVal = null;
    
29.                 int role  =  getControllerMethodRole(joinPoint);
    
30.                 TeacherEntity user = CommonUtil.getUser();
    
31.                 if((user.getSpecRole()&role)==role){//没有权限
    & A3 P8 \% L0 E* b+ \
32.                         retVal  = joinPoint.proceed();
    ! n1 |/ U) k9 p
33.                 }else{
    $ K8 ?3 U" s. P" q+ u7 K3 U- r: O/ C
34.                         noAuthorization();
    $ w5 \  M; a; n' m, }
35.                 }
    1 y$ q3 a/ |, M
36.             return retVal;
    . U' V8 Y% C) E0 b6 I
37.     }
    
38.     /**
    , U$ c7 B% z6 V% v0 i2 H: e* U
39.      * 没有权限 实现跳转
    
40.      * @Author        张志朋
    
41.      * @throws IOException  void
    
42.      * @Date        2015年7月3日
    
43.      * 更新日志
    
44.      * 2015年7月3日 张志朋  首次创建
    9 N) g( S' T7 G- m( M
45.      *
    
46.      */
    % _6 x7 u+ y# ]8 l* X/ u9 d* a
47.     public void noAuthorization() throws IOException{
    7 L. k3 e  y8 j5 `7 J
48.             HttpServletRequest request = ServletActionContext.getRequest();
    
49.                 String path =  request.getContextPath();
    * F; }4 t' u0 ], _* `/ z
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    
52.     }
    8 ]7 ?# x5 K9 b. R
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    0 \8 X! C& {5 l2 R+ l4 j
55.      * @Author        张志朋
    ! Q4 p0 Z# o8 ?
56.      * @param joinPoint
    # k. z) h, X2 q! R9 a& w3 B7 _
57.      * @return
    
58.      * @throws Exception  int
    
59.      * @Date        2015年7月3日
    
60.      * 更新日志
    / O/ @0 }8 t; G4 Y* {/ o
61.      * 2015年7月3日 张志朋  首次创建
    
62.      *
    2 w  b% R+ E* G$ ?! f
63.      */
      r; I& C9 L! N' Y  F
64.     @SuppressWarnings("rawtypes")
    ( \- X5 s: {/ E+ U+ u8 m7 W# H
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    
67.         String methodName = joinPoint.getSignature().getName();   
    ) E1 m4 L' R4 `& x' b1 w/ r
68.         Object[] arguments = joinPoint.getArgs();   
    + A5 y  w) i$ F) b- J8 _. \7 u5 t2 v
69.         Class targetClass = Class.forName(targetName);   
    
70.         Method[] methods = targetClass.getMethods();   
    
71.         int role = -1;   
    
72.          for (Method method : methods) {   
    
73.              if (method.getName().equals(methodName)) {   
    
74.                 Class[] clazzs = method.getParameterTypes();   
    
75.                  if (clazzs.length == arguments.length) {   
    1 T: n9 l! ]3 z/ x
76.                          role = method.getAnnotation(Permission. class).id();   
    
77.                      break;   
    
78.                 }   
    1 K) |8 q1 Z- C5 V2 i
79.             }   
    ! A0 \2 Z: T! S4 g) T; p4 S/ c
80.         }   
    
81.          return role;   
    
82.     }

复制代码

2.action层代码实现：
; h! c$ \6 L% y7 g8 u7 _

1. /**
   ' Z- q( C8 v# W/ Y* y  P, z
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
   
4.          * @Date        2015年5月4日
   
5.          * 更新日志
   
6.          * 2015年5月4日 张志朋  首次创建
   7 o" }, n, j- J. z
7.          *
   6 }! G: m( m! M& a
8.          */
   * K& L6 `. [* s5 _8 A% y
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   1 U% {1 S- ^1 [, c* `+ t/ P
10.         public void auditQuestions(){
    8 ]4 {; {: I& c. Z! K3 z* V
11.                 try {
      O: e. M* E$ `# Z
12.                      //代码实现
    0 u4 o9 {3 w6 X) A# y
13.                 } catch (Exception e) {
    
14.                      e.printStackTrace();
    
15.                 }
    / v0 r  I4 v- k/ V5 p' Y
16. 
    4 D# d& a2 C9 H
17.         }

复制代码

共同研讨

真的是不错的东西 支持楼主

共同研讨

不错的东西    支持下

gaoxiang1985

支持楼主·································

毛小豆

这么近距离的看到了Aop的代码。不错。很易懂

wfymqj

过来学习高手的代码了。支持楼主！

xiaohan

楼主威武，感谢楼主

java侠

感谢楼主分享，

贝斯特

感谢 分享  

明月照大江

不错，谢谢