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

admin

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

( W7 K/ X- d! G: T. x8 F( j

       一般我们的异常都会抛出到控制层，如果使用struts2也就是action。然后try{//正确代码实现}catch{//在里面记录错误日志}，这样咋一看是不错，代码很完美。但是如果项目中有成千上万个项目怎么办？难道在每个action的catch里面都要加入异常记录代码？很显然工作量是很大的。
4 M5 q1 m: C" z' [; ^
+ p$ N2 t4 ]6 _; s
       鉴于项目中配置了数据库事务，其实也是使用了AOP 详见applicationContext-service.xml配置文件。由于配置文件的局限性这里采用注释的方式实现。之所有使用注释是可以自定义参数并实现日志的详细记录。既然使用注释，现成的没有，只有自己定义来实现需求。其实spring 注释实现的注入、hibernate的model类注释实现与数据库关联以及我们最常见Override。
       资料:java如何实现自定义注释http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html
( O) k4 Q" T# ?- f
一、 记录日志并发送邮件通知
(1)、定义注解：
" B/ b# V# f8 i- s, W. n* u1.ServiceLog.java(各种参数类型详见上面的资料)

1. import java.lang.annotation.*;
   * ^* R5 V" k: p) Q- r- o
2. /**
   
3. * 自定义注解 拦截service  
   9 i! I2 l9 Z4 o
4. * 创建者        张志朋
   # J& f: d' f. B( `- d) s# w
5. * 创建时间        2015年6月3日
   ( F% C& J' m  l8 s# v  w, |) y4 X
6. *
   : S4 s, b# P0 t9 C; s0 h0 O
7. */
   : |0 k: r6 Z# D0 h' `& B2 r. l
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    , q+ g1 ?; ?) d. W
11. public  @interface ServiceLog {
    3 y4 x; \" u8 p9 `& u2 {# Z, [( G
12.          String description()  default "";
    
13. }

复制代码

2.ControllerLog.java

1. import java.lang.annotation.*;
   ) |  B( r! Q0 w; r% t
2. /**
   
3. * 自定义注解 拦截Controller
   * S- K8 H. }2 Q) Z" F
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   
6. *
   8 f# G' y$ e+ P4 A
7. */
   . d& y8 |) v, s  w2 j
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   5 S7 Y% f- Z/ {9 P) x: M6 C6 B
10. @Documented
    
11. public @interface ControllerLog {
    
12.         String description()  default "";
    . f- w. d; O  g( h! a; J% F$ J
13. }

复制代码

(2)、定义切面以及切入点
  W, q! i# c  A1.LogAspect.java
5 E5 W. x# \6 ]' @& i

1. /**
   
2. * 日志记录AOP
   6 W; r. \" S0 P7 Y- c
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月3日
   + d! V) Y  Q* \4 |
5. *
   5 T1 r& Q5 f- K
6. */
   5 a; M0 @. X8 c" ~3 ^6 ]7 ]
7. @Component
   & B9 y0 K% u$ ~# K+ s$ f+ K
8. @Scope
   
9. @Aspect
   : X1 Y3 y9 s1 r3 i$ W: w
10. public class LogAspect {
    
11.         //Service层切点     用于记录错误日志
    1 q; _9 l% T& T9 B) b8 g
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    
13.         public void serviceAspect() {
    
14.                
    : T3 H% \# F+ ?$ t8 o/ f
15.         }
    , p2 r. P9 z; f9 ]
16.     /**
    
17.      * 异常通知 用于拦截service层记录异常日志  
    4 H4 u  N1 s5 ~, v1 T+ n/ a6 m0 f
18.      * @Author        张志朋
    
19.      * @param joinPoint
    
20.      * @param e  void
    
21.      * @Date        2015年6月3日
    0 X( x: i7 _+ p2 X
22.      * 更新日志
    . x+ S* A* F1 R$ U7 E
23.      * 2015年6月3日 张志朋  首次创建
    , \! `9 J# K4 t/ Y& ]
24.      *
    
25.      */
    
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    8 s! H. R; {; Z1 i/ v  n
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    
29.                 TeacherEntity user = CommonUtil.getUser();
    
30.                 String ip = AddressUtils.getIpAddr(request);
    # U- ]4 L9 c9 f  o3 o+ E
31.                 try {
    
32.                         String params = "";
    4 _9 m( H: ~9 W/ Z" b. O6 @9 s' j
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    + @9 o0 l  h; X9 C+ V& w
36.                                 }
    , ^; o9 ?% F* q- [2 I) G# c7 q  ]
37.                         }
    
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    % N$ `) Y+ ~/ V5 E4 v
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    , |( ?' p* Z7 n1 B; Y3 k
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    & G) k, i- L0 i" J
42.                         /*==========记录数据库异常日志==========*/  
    
43.                         Log log = new Log();
    # S& a8 j# L2 p6 Q& T
44.                         log.setDescription(description);
    4 c  ]; j# G9 l
45.                         log.setExceptionCode(exceptionCode);
    ( L: H: c7 @0 X* t' b
46.                         log.setExceptionDetail(exceptionDetail);
    
47.                         log.setMethod(method);
    4 V# `: s+ O7 q
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    
50.                         log.setParams(params);//请求参数
    4 X% B# u# ^. F! E6 k6 b& J6 k1 e
51.                         if(null!=user){
    ; [6 J' }% G3 T- ^8 c3 Y# ~; v6 i
52.                     log.setCreateUid(user.getUid());//用户ID
    / b+ y6 g' \* H' D- g
53.                     log.setCreateName(user.getNickname());//用户昵称
    
54.             }
    6 x. a8 e' e7 [, e0 n2 d3 D
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    % b% s* r4 W6 |7 H
56.                         /*==========记录数本地异常日志==========*/  
    & ]/ L" _7 O+ i. {0 M* m
57.                         //LogUtil.error(description, e);
    
58.                         /*==========发送异常日志到邮箱==========*/
    : b0 W! h! O( p+ [
59.                         StringBuffer errorMsg = new StringBuffer();
    
60.                         errorMsg.append("异常方法:");
    
61.                         errorMsg.append(method);
    
62.                         errorMsg.append("</br>");
    ! j( O0 I8 |6 I! l2 d
63.                         errorMsg.append("异常类型代码:");
    . T9 X6 l! u3 b' \: a3 m' Z0 C
64.                         errorMsg.append(exceptionCode);
    $ O, f5 C2 u" y" r5 L- K, w# B
65.                         errorMsg.append("</br>");
    
66.                         errorMsg.append("异常详细信息:");
    * O9 M& w: a  R. r
67.                         errorMsg.append(exceptionDetail);
    
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    9 f9 ], M4 T  X# p7 F
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    
73.                         e.printStackTrace();
    / `. C9 P: R# T: K- A+ c8 a
74.                 }
    . J: n4 Y& N9 q$ s, @% Q
75.     }
    / o4 S5 _) Y. M' @% r
76.      /**
    
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    
78.       * @Author        张志朋
    
79.       * @param joinPoint
    
80.       * @return
    ! r  J6 ~" T- q* d7 _
81.       * @throws Exception  String
    6 ~( U9 i2 A/ s% m
82.       * @Date        2015年6月3日
    
83.       * 更新日志
    
84.       * 2015年6月3日 张志朋  首次创建
    6 T  G8 H# _' e) y
85.       *
    # T$ q2 d1 ^9 ?# q! f4 J: O
86.       */
    
87.      @SuppressWarnings("rawtypes")
    ! y9 d2 x6 g2 I' T
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    
89.              throws Exception {   
    
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    
91.         String methodName = joinPoint.getSignature().getName();   
    . E9 {0 \) a' i
92.         Object[] arguments = joinPoint.getArgs();   
    8 a  a' B. k( G
93.         Class targetClass = Class.forName(targetName);   
    : a6 E: D* w$ {3 C* ^' t( j
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    , j' `% L5 U, y' B2 U
96.          for (Method method : methods) {   
    
97.              if (method.getName().equals(methodName)) {   
    $ ], h2 h3 U- a* x) e
98.                 Class[] clazzs = method.getParameterTypes();   
    
99.                  if (clazzs.length == arguments.length) {   
    0 f# X+ r2 _) a
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     / [4 O: D1 j+ S# Y. m
101.                      break;   
     + P9 L  ]: C, p* u0 x+ u" ~8 n+ m& S7 g
102.                 }   
       m) d9 Y) C  Y* [
103.             }   
     : A2 h2 f- w8 a4 Y
104.         }   
     # F& M" A, H9 ^! ^7 l
105.          return description;   
     
106.     }
     4 c) C* A: W" _" u1 K& l& A8 Q
107.     }

复制代码

5 n  m& k' k  ?4 }6 ?这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
doAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。
  N8 k- a+ T: j/ {! N2 {5 y
2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）
0 H$ t$ `' D0 M2 X3 W% @

1. @ServiceLog(description="获取待审试题数量")
   
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   # U4 B. l. m: |# f
4.         }

复制代码

9 N/ ]& v. ?7 X+ j5 z之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
二、AOP实现权限控制
" g5 K0 w' f  k  T" e2 f+ ]       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
* f  w9 c! e/ Y* e; i        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
1 Z) i9 m; t; ^# z- g# K; D首先配置文件要引入这样一段配置(看注释说明)：

1. <!--通知spring使用cglib而不是jdk的来生成代理方法 AOP可以拦截到Controller(Action)-->
   
2.         <aop:aspectj-autoproxy proxy-target-class="true"/>

复制代码

(1)、定义注释：
+ t) w8 g+ F+ S  ^1.Permission.java
" C# ]/ ?+ H- z- R7 g% {

1. /**
     X- ^* k& x6 `& a5 ^
2. * 自定义权限管理
   
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月30日
   % {# i) ?# B9 }
5. *
   
6. */
   . ?+ o; Z, C: `* q4 m# y2 e
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   : j0 K+ A- T* m* @
8. @Retention(RetentionPolicy.RUNTIME)   
   4 U4 _7 r. J* I8 j6 _; C, P
9. @Documented
   
10. public @interface Permission {
    . [# U6 N' d9 c" R( F1 t6 v
11.         String name()  default ""; //操作行为
    
12.         int id() default -1;//权限值
    
13. }

复制代码

(2)、定义切面以及切入点
' V8 j" G( v  M# E1.PsemissionAspect.java

1. /**
   
2. * 权限管理
   / r: G/ X; e0 [. r* d: Q
3. * 创建者        张志朋
   
4. * 创建时间        2015年7月3日
   
5. *
   : p. B5 q2 D3 P$ H
6. */
   7 g! E0 M- ?( _
7. @Component
   ( s7 p0 {) d, `, ?. Q" g
8. @Scope
   
9. @Aspect
   - i' ^7 f* O4 A4 ]+ h
10. public class PsemissionAspect {
    
11.         
    , T; }" K6 Y  ]+ N/ c
12.     //Controller层切点 用于权限控制
    
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    
14.         public void permissionAspect() {
    
15.                
    * H. h3 U& r1 W/ J; e" j
16.         }
    5 n3 C! ^! D; M- Q
17.         /**
    
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    
19.          * @Author        张志朋
    1 Y3 j7 f1 g  _+ ]
20.          * @param joinPoint  void
    $ Z7 o9 e  M; E& u8 j
21.          * @Date        2015年6月3日
    $ i- z  S: u0 I  i6 ]# q
22.          * 更新日志
    1 B  O" S6 T6 c5 Q- ]" D
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    
25.          */
    0 `7 Z, n+ O5 Z' h1 N
26.     @Around("permissionAspect()")   
    ) Y: @1 E! p1 I
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    ! O/ ]0 C  c  J  }; {, |5 x
28.         Object retVal = null;
    2 I# Z- m6 l# d4 R, c" E
29.                 int role  =  getControllerMethodRole(joinPoint);
    $ L0 |  h9 p8 N
30.                 TeacherEntity user = CommonUtil.getUser();
      k- ]% ]7 {1 l9 e
31.                 if((user.getSpecRole()&role)==role){//没有权限
    
32.                         retVal  = joinPoint.proceed();
    * H- }% w5 ^+ j6 n7 a
33.                 }else{
    * l! }( M7 p  L1 a: y4 b
34.                         noAuthorization();
    
35.                 }
    
36.             return retVal;
    2 n$ E. i& l: y" J7 [% s% y  l( t
37.     }
    
38.     /**
    8 z) n7 F  ~) N: c
39.      * 没有权限 实现跳转
    
40.      * @Author        张志朋
    2 U8 \3 U9 ?4 ?# D* v
41.      * @throws IOException  void
    4 C# P9 d4 I9 f" R
42.      * @Date        2015年7月3日
    4 q8 f5 O$ m" f7 ^$ [
43.      * 更新日志
    4 O$ d; \' Q* U' \8 `
44.      * 2015年7月3日 张志朋  首次创建
    
45.      *
    + P- Y. h: l' D0 U
46.      */
    4 w2 a9 s. @7 n- j. a2 F
47.     public void noAuthorization() throws IOException{
    6 ?0 h6 i- L" M
48.             HttpServletRequest request = ServletActionContext.getRequest();
    ! x1 D) b) z' I+ B
49.                 String path =  request.getContextPath();
    + F/ o7 O2 \% I  }& r
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    & p6 G% Z9 Z2 v
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
      D3 L( \. H! b: t
52.     }
    6 S4 Q3 _  U0 X$ @8 ?& Y
53.     /**
    6 f  u# S& B0 }
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    " Z/ L9 |, j* }* w
55.      * @Author        张志朋
    
56.      * @param joinPoint
    
57.      * @return
    - I& O$ A5 G: T1 U0 _- B
58.      * @throws Exception  int
    
59.      * @Date        2015年7月3日
    
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    ( J; K: X# k7 ^
62.      *
    
63.      */
    4 U3 Q- _+ W( w3 w& Q/ \1 k
64.     @SuppressWarnings("rawtypes")
    
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    3 B, |" Y& T* m1 l$ \* v, Q
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
    , p2 B7 B7 I0 ?" s0 T4 h
69.         Class targetClass = Class.forName(targetName);   
    & M, A2 B3 b: @
70.         Method[] methods = targetClass.getMethods();   
    
71.         int role = -1;   
    
72.          for (Method method : methods) {   
    - I6 M7 T4 W, y4 j9 R
73.              if (method.getName().equals(methodName)) {   
    
74.                 Class[] clazzs = method.getParameterTypes();   
    . ^$ }8 n3 ~7 Y
75.                  if (clazzs.length == arguments.length) {   
    " |( {; k" R0 ~9 \* H. ?( D  d1 [: L
76.                          role = method.getAnnotation(Permission. class).id();   
    
77.                      break;   
    
78.                 }   
    
79.             }   
    9 U7 v# N0 \0 Y. V" J+ N; J' |( \
80.         }   
    
81.          return role;   
    
82.     }

复制代码

2.action层代码实现：

1. /**
   
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
   4 u2 H! }- V' @
4.          * @Date        2015年5月4日
   
5.          * 更新日志
   " W7 Q! ?$ y2 S
6.          * 2015年5月4日 张志朋  首次创建
   5 I  U( B: O. h3 Z5 O
7.          *
   , m$ X+ \: Y; F. E; r  Y! B
8.          */
   
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   ! {& S4 f) {# ~3 s; q. g/ j- k
10.         public void auditQuestions(){
    ' n4 W! z+ M. s5 f
11.                 try {
    3 I$ w4 M: W! ~4 a+ d  f0 X0 l/ U5 Q
12.                      //代码实现
    # y3 b. S% h1 r1 b/ e! `' p& U
13.                 } catch (Exception e) {
    
14.                      e.printStackTrace();
    
15.                 }
    
16. 
    . T9 d" E4 O3 S6 G% @' D
17.         }

复制代码

4 k7 G0 s: N8 ?) A! Z

共同研讨

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

共同研讨

不错的东西    支持下

gaoxiang1985

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

毛小豆

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

wfymqj

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

xiaohan

楼主威武，感谢楼主

java侠

感谢楼主分享，

贝斯特

感谢 分享  

明月照大江

不错，谢谢