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

admin

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

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

       鉴于项目中配置了数据库事务，其实也是使用了AOP 详见applicationContext-service.xml配置文件。由于配置文件的局限性这里采用注释的方式实现。之所有使用注释是可以自定义参数并实现日志的详细记录。既然使用注释，现成的没有，只有自己定义来实现需求。其实spring 注释实现的注入、hibernate的model类注释实现与数据库关联以及我们最常见Override。
       资料:java如何实现自定义注释http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html
& Z# E* h! F# G- _/ ?# k# y2 h
7 n; x: [$ t, c1 n( g7 ~- ]一、 记录日志并发送邮件通知
(1)、定义注解：
1.ServiceLog.java(各种参数类型详见上面的资料)
, Y+ ]: b: Z$ ~* W' K

1. import java.lang.annotation.*;
   
2. /**
   
3. * 自定义注解 拦截service  
   
4. * 创建者        张志朋
   2 J2 ^/ Y, i7 H1 {
5. * 创建时间        2015年6月3日
   , P- \$ W3 i* z3 J  }
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   - @. U5 J* @# Q) \1 I( ?$ l
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    8 v1 H# ~8 F( c1 E+ Q
11. public  @interface ServiceLog {
    & ~+ g1 w/ \7 v  v9 W" I3 S
12.          String description()  default "";
    ! u' B" V  }3 N# u' y9 W# ]
13. }

复制代码

2.ControllerLog.java
5 F9 t4 f- E9 w) w

1. import java.lang.annotation.*;
   0 d. G5 P& m" {8 B; z0 Y  X& |1 M
2. /**
   . `5 T+ I5 ^- a. W
3. * 自定义注解 拦截Controller
   
4. * 创建者        张志朋
   4 u5 r) i7 z3 u, x, o$ O$ I
5. * 创建时间        2015年6月3日
   
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented
    - V9 ~/ P! b* g* {' F( f3 F7 ~2 Z; U; `
11. public @interface ControllerLog {
    ! ]* L6 R7 ~2 _9 x% C  _
12.         String description()  default "";
      l' v. u/ i+ x1 E" I
13. }

复制代码

(2)、定义切面以及切入点
" ]9 W5 Y; d; P: e8 K1.LogAspect.java
- @5 J  L$ x: J% P( E9 {* M2 q

1. /**
   
2. * 日志记录AOP
   - J" D" \, r1 f- G# r; ^* y  |
3. * 创建者        张志朋
   # I3 {* S3 z; q7 O
4. * 创建时间        2015年6月3日
   
5. *
   + k. P  {6 }' x; X9 {- `' m# G
6. */
   
7. @Component
   1 Z, [) G. V, d& F# k0 F% b
8. @Scope
   - }! L. L( H: F! U- b/ p
9. @Aspect
   
10. public class LogAspect {
    
11.         //Service层切点     用于记录错误日志
    % E- R) [: f0 b( i) E
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    ' b! m: w8 Z/ x$ D& ]
13.         public void serviceAspect() {
    7 _2 x( C8 q0 b% {4 g; G# v
14.                
    
15.         }
    
16.     /**
    
17.      * 异常通知 用于拦截service层记录异常日志  
    & [9 o: P4 R; E. {7 k) ?% ]5 W" @
18.      * @Author        张志朋
    
19.      * @param joinPoint
    
20.      * @param e  void
    - ?+ M& @& p) E0 d- s$ ?
21.      * @Date        2015年6月3日
    
22.      * 更新日志
    
23.      * 2015年6月3日 张志朋  首次创建
    , }: X5 w' G* w9 I
24.      *
    - Q6 H, k: O' O' t( v* w; _
25.      */
    
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    
29.                 TeacherEntity user = CommonUtil.getUser();
    2 j" f- n6 q$ c# B6 \
30.                 String ip = AddressUtils.getIpAddr(request);
    4 k) r7 t* e& e
31.                 try {
    ! A- _; L) q3 [! F
32.                         String params = "";
    % C* b( S8 K2 R4 |2 ]
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
      P4 A* n: ^, o( W7 e
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    
36.                                 }
    
37.                         }
    
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    2 G2 M: z* g5 Y" h! z6 ~
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);
    + S3 B: W% S2 a  s, d; q9 N
45.                         log.setExceptionCode(exceptionCode);
    
46.                         log.setExceptionDetail(exceptionDetail);
    
47.                         log.setMethod(method);
    
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    / E% R! T+ c& Z9 r6 Z
50.                         log.setParams(params);//请求参数
    + h. h- t( t3 a* F! h, Z- }% p. s
51.                         if(null!=user){
    ' d* Z: y4 x! C) |; i
52.                     log.setCreateUid(user.getUid());//用户ID
    , I( h" @/ y# a  _7 x+ @4 Z5 i% r4 s. ?: Q
53.                     log.setCreateName(user.getNickname());//用户昵称
    2 A  V# s/ B" ]' S
54.             }
    / u$ ]: G7 X- }: H' ?/ x3 Z% f" G
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    * M. |. W$ a7 J4 ?
56.                         /*==========记录数本地异常日志==========*/  
    
57.                         //LogUtil.error(description, e);
    * B- g9 d) l' R6 o, Z  S- c2 M
58.                         /*==========发送异常日志到邮箱==========*/
    
59.                         StringBuffer errorMsg = new StringBuffer();
    : U9 N! C3 v8 Y1 T  y/ r& d9 U% K6 M
60.                         errorMsg.append("异常方法:");
    5 {( s' a! N" l6 u& u4 l" K
61.                         errorMsg.append(method);
    
62.                         errorMsg.append("</br>");
    
63.                         errorMsg.append("异常类型代码:");
    
64.                         errorMsg.append(exceptionCode);
    1 P, A2 c& n0 J& C/ x
65.                         errorMsg.append("</br>");
    # F4 ?( }3 g1 e1 U; J" O$ `
66.                         errorMsg.append("异常详细信息:");
    * r! c9 S0 x5 |. d! e
67.                         errorMsg.append(exceptionDetail);
    ; T* N+ M2 p  U0 E: I0 [* s0 O
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    + |8 m/ @7 C6 Y# B
71.                         Client.sendError(log);
    " ^9 @6 Z; X8 X( m% U0 }4 X
72.                 } catch (Exception ex) {
    4 c( z$ k+ y. f$ c
73.                         e.printStackTrace();
    % @' Z5 |# O2 K
74.                 }
    2 e3 }: [$ o3 i& |8 M1 P! @
75.     }
    + S' M/ t( [4 c* K5 J( ^, a9 H
76.      /**
    ' a/ C  I7 `1 D: N
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    
78.       * @Author        张志朋
    
79.       * @param joinPoint
    
80.       * @return
    
81.       * @throws Exception  String
    : k, h; P" X* G' ]% {% A
82.       * @Date        2015年6月3日
    8 |4 Z5 a% F6 w( X
83.       * 更新日志
    
84.       * 2015年6月3日 张志朋  首次创建
    " e9 |1 Y- `1 x4 R% o% {
85.       *
    ! p8 y# \& T- U: G2 K4 K7 D
86.       */
    - w' [  i  O5 _/ q& o$ {; j9 v/ n$ U
87.      @SuppressWarnings("rawtypes")
    % K5 b7 F( m- z6 o7 B4 g) x" Z
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    
89.              throws Exception {   
    4 h" O) B/ l( n! Y2 f
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    ( O, C  s+ C' ~9 t
91.         String methodName = joinPoint.getSignature().getName();   
    
92.         Object[] arguments = joinPoint.getArgs();   
    
93.         Class targetClass = Class.forName(targetName);   
    # a, Y: R$ g$ r0 f( I1 c' W$ C
94.         Method[] methods = targetClass.getMethods();   
    5 P' x' j% a$ K, l
95.         String description = "";   
    ( [9 w8 O1 A8 W) z- n
96.          for (Method method : methods) {   
    # Z- v. L) m6 j, u4 N
97.              if (method.getName().equals(methodName)) {   
    
98.                 Class[] clazzs = method.getParameterTypes();   
    
99.                  if (clazzs.length == arguments.length) {   
    , T, L5 b' g! ~( {$ U: ?. _
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     : V' P* m0 H/ z! d2 [% I! h
101.                      break;   
     
102.                 }   
     6 x' H1 s9 p+ X, D
103.             }   
     & @. d9 u/ k' C% @; q5 |
104.         }   
     $ R$ w2 {# {/ u7 O. z1 k: p
105.          return description;   
     
106.     }
     , Z0 w# y* O/ h, s) ]
107.     }

复制代码

这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
doAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。
, X, G+ o5 Q. [; l1 J! S$ |$ L( j
3 P, B' v1 k" _6 z- n3 o7 X/ j2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）

1. @ServiceLog(description="获取待审试题数量")
   
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   / b: A, S' E. n
4.         }

复制代码

之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
: Q: s2 d. {9 F# w: L二、AOP实现权限控制
       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
6 _( \! b+ F1 X        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
首先配置文件要引入这样一段配置(看注释说明)：

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

复制代码

' c3 \7 e6 B/ T, P(1)、定义注释：
  O" }$ F5 l$ |8 ^7 D  F! f, F1.Permission.java
8 s* b7 K+ i7 f" O% x' h

1. /**
   
2. * 自定义权限管理
   0 ], p7 Q* D+ H6 `0 y: P+ [3 n
3. * 创建者        张志朋
   8 ]- K. W( s- n+ t' G% k
4. * 创建时间        2015年6月30日
   
5. *
   * @) [+ s  j9 |7 l# p: H
6. */
   7 B8 \5 ^) P3 i# h" C
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   . Q, Y# Z1 O7 {: X: A. m. C
8. @Retention(RetentionPolicy.RUNTIME)   
   9 d' z, i2 X" t( ]7 @1 |
9. @Documented
   
10. public @interface Permission {
    , X2 Y, p/ q$ J$ F5 O3 O+ {
11.         String name()  default ""; //操作行为
    
12.         int id() default -1;//权限值
    
13. }

复制代码

(2)、定义切面以及切入点
. I3 ]! I0 ]- U- m1.PsemissionAspect.java

1. /**
   
2. * 权限管理
   ! ~! e9 u" ]2 v( R
3. * 创建者        张志朋
   
4. * 创建时间        2015年7月3日
   
5. *
   
6. */
   5 G3 p5 x8 t+ H* j. I( y2 ]6 J
7. @Component
   ) ?  E; D  M  X' U+ l
8. @Scope
   0 `2 P6 j! X, k% h6 G- R
9. @Aspect
   
10. public class PsemissionAspect {
    9 Y/ k5 F& B# z% L. H& E8 V  `: |8 x; K
11.         
      n. w" P0 u! }5 B( Q
12.     //Controller层切点 用于权限控制
    
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    8 ]% v9 n+ o3 F1 E) Q
14.         public void permissionAspect() {
    + x+ E( A$ e3 {+ m9 M7 L3 m
15.                
    8 S) _0 @) O! T, i
16.         }
    
17.         /**
    
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    2 A% w) A+ m0 H  H# ]
19.          * @Author        张志朋
    
20.          * @param joinPoint  void
    # `' E* y* p2 [1 E0 J% Y& ]
21.          * @Date        2015年6月3日
    ! w  F  _5 q% O  }
22.          * 更新日志
    
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    ; x9 m8 n  K/ p) r8 y0 K* ]
25.          */
    ; U7 n) v: A& \
26.     @Around("permissionAspect()")   
    4 @: J( r5 r3 \5 q
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    " }* O7 O+ R/ c9 U! n2 L8 {
28.         Object retVal = null;
    7 G2 B7 R8 K# P+ ?2 l
29.                 int role  =  getControllerMethodRole(joinPoint);
    
30.                 TeacherEntity user = CommonUtil.getUser();
    
31.                 if((user.getSpecRole()&role)==role){//没有权限
    9 v! t+ q8 z' t* D
32.                         retVal  = joinPoint.proceed();
    1 u5 J9 f0 k! q3 X6 Q' w
33.                 }else{
    , ]3 d5 `2 L: a$ `+ e# o' d# ?
34.                         noAuthorization();
    # O! g9 M3 t* h" f  C: L! z8 l
35.                 }
    
36.             return retVal;
      e2 Y$ m2 j) [4 c$ T
37.     }
    . U/ T' |* i6 o- s
38.     /**
    * g8 n' y& \7 H) P
39.      * 没有权限 实现跳转
    & |- r6 J' F6 `; p% S
40.      * @Author        张志朋
    , O, V: d) v# [" H# P) b) P2 F/ S
41.      * @throws IOException  void
    
42.      * @Date        2015年7月3日
    
43.      * 更新日志
    
44.      * 2015年7月3日 张志朋  首次创建
    
45.      *
    * i. x8 i9 B( [. n2 Q- }# l
46.      */
    7 w* d3 Y, P/ |" A: M( p
47.     public void noAuthorization() throws IOException{
    
48.             HttpServletRequest request = ServletActionContext.getRequest();
    ' ]6 `2 V5 l# \% ~
49.                 String path =  request.getContextPath();
    
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    # P6 x- r5 B3 P: o1 n. o
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    0 ~/ m1 B; l0 e
52.     }
    
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    & G9 [3 P" Z& n8 H) E  @  W
55.      * @Author        张志朋
    
56.      * @param joinPoint
    
57.      * @return
    
58.      * @throws Exception  int
    
59.      * @Date        2015年7月3日
    & l6 `# Z6 m9 B
60.      * 更新日志
    4 o4 {8 @$ b8 u# N9 s5 ?% P, e8 G
61.      * 2015年7月3日 张志朋  首次创建
    9 ~1 C5 g& K9 n  g2 @
62.      *
    
63.      */
    3 D$ E0 ~4 e. d' S/ {) z, z
64.     @SuppressWarnings("rawtypes")
    
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    4 h9 Z, F6 L" }1 n
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
    
69.         Class targetClass = Class.forName(targetName);   
      p- |, G' m. L9 t
70.         Method[] methods = targetClass.getMethods();   
    % ]. a* Y4 @4 |
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) {   
    ! C% j! A  H+ G* t9 w( s" T! R
76.                          role = method.getAnnotation(Permission. class).id();   
    7 U$ }. ]) N* h2 z+ I' B% h
77.                      break;   
    * J5 U9 L# h; Z: V, h
78.                 }   
    , ^$ K# A" F2 ?3 |& N* X
79.             }   
    
80.         }   
    
81.          return role;   
    ) S9 F+ l9 K- f: z- L
82.     }

复制代码

2.action层代码实现：

1. /**
   ; w, |) w+ F' t, j# b& R0 B2 v
2.          * 试题审核不通过
   : L' c9 {* X. y
3.          * @Author        张志朋  void
   
4.          * @Date        2015年5月4日
   
5.          * 更新日志
   " o" l3 h; Y( V: L
6.          * 2015年5月4日 张志朋  首次创建
   
7.          *
   " b) [% N# x1 c9 Q* b! R. a
8.          */
   
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   . X; t* w* I) _6 ?9 r
10.         public void auditQuestions(){
    
11.                 try {
    ; U2 Q" ^% t! N
12.                      //代码实现
    
13.                 } catch (Exception e) {
    
14.                      e.printStackTrace();
    ; f  Q( ]# K9 S
15.                 }
    
16. 
    * ^6 g+ R: N. T9 q
17.         }

复制代码

共同研讨

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

共同研讨

不错的东西    支持下

gaoxiang1985

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

毛小豆

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

wfymqj

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

xiaohan

楼主威武，感谢楼主

java侠

感谢楼主分享，

贝斯特

感谢 分享  

明月照大江

不错，谢谢