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

admin

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

* X1 O, C: `4 N0 g0 l

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

& W8 D7 q7 R2 k  }4 Z+ |一、 记录日志并发送邮件通知
(1)、定义注解：
1.ServiceLog.java(各种参数类型详见上面的资料)
- M- y- k( \3 Z: a7 [: g, k* _

1. import java.lang.annotation.*;
   
2. /**
   
3. * 自定义注解 拦截service  
   
4. * 创建者        张志朋
   * t5 c. Q5 [6 t" N
5. * 创建时间        2015年6月3日
   
6. *
   
7. */
   7 X' L5 f  \- N( i4 t8 F+ V% Q* c8 ^
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    
11. public  @interface ServiceLog {
    " R% ?6 f" [; h( t% C
12.          String description()  default "";
    
13. }

复制代码

2.ControllerLog.java

1. import java.lang.annotation.*;
   
2. /**
   3 ^( x- V1 b8 D9 |+ D; _+ N  r7 k9 ~, x
3. * 自定义注解 拦截Controller
   . k4 z' a4 g' n4 p* j
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   
6. *
   1 H7 T! T* b0 w  w
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   ! c# S! Z: R. H% Y7 i6 ~3 H
10. @Documented
    ( v6 l' ?: m) @# v# r! F# Y# F' Q
11. public @interface ControllerLog {
    
12.         String description()  default "";
    " i( I1 N5 j! Q2 x6 W
13. }

复制代码

(2)、定义切面以及切入点
1.LogAspect.java

1. /**
   
2. * 日志记录AOP
   
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月3日
   5 q2 Q  h) H9 }/ y$ L* X0 C' M
5. *
   
6. */
   + Y5 w. V! G: \  |8 _
7. @Component
   
8. @Scope
   9 m) Z$ D8 C$ M! Y/ D! E( ?; [3 h
9. @Aspect
   3 h, z" z) p$ N1 C: X; F8 Z
10. public class LogAspect {
    7 n) A$ d/ w; y! h" s
11.         //Service层切点     用于记录错误日志
    
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    
13.         public void serviceAspect() {
    
14.                
    
15.         }
    $ m) j; `7 h  ?
16.     /**
    
17.      * 异常通知 用于拦截service层记录异常日志  
    
18.      * @Author        张志朋
    % k6 ^; g8 d/ m( U8 @. ~
19.      * @param joinPoint
    5 x; ]# l$ f9 E# M# ]1 M! D
20.      * @param e  void
    
21.      * @Date        2015年6月3日
    ' j; z( \* c0 C% Q' Q
22.      * 更新日志
    
23.      * 2015年6月3日 张志朋  首次创建
    9 W( V# r8 z! i+ l7 \
24.      *
    
25.      */
      ]( k' C; K, G+ f9 v
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    
29.                 TeacherEntity user = CommonUtil.getUser();
    $ A, B% p1 A  h+ C9 B
30.                 String ip = AddressUtils.getIpAddr(request);
    
31.                 try {
      t5 E& u. g1 X% y, ?7 X
32.                         String params = "";
    : n. d& g' p; d# V
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]) + ";";
    * n$ W% d0 v: ?3 e2 l6 |, q
36.                                 }
    
37.                         }
    ! s& v) A2 O4 e
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    
42.                         /*==========记录数据库异常日志==========*/  
    6 e8 a4 T) i3 T- a0 i- k- a
43.                         Log log = new Log();
    
44.                         log.setDescription(description);
    . M$ E6 j7 Z% Y. M3 X
45.                         log.setExceptionCode(exceptionCode);
    
46.                         log.setExceptionDetail(exceptionDetail);
    - x+ X9 o% S0 d' [% Z
47.                         log.setMethod(method);
    , u9 {+ V) B+ K7 V/ T  P% Q7 O
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    8 D1 w% t$ k4 t7 b' ^9 C% N/ h
49.                         log.setRequestIp(ip);// 请求IP
    
50.                         log.setParams(params);//请求参数
    
51.                         if(null!=user){
    4 r1 }/ j" \: w; C! t( j& e
52.                     log.setCreateUid(user.getUid());//用户ID
    
53.                     log.setCreateName(user.getNickname());//用户昵称
      }' e( c7 S9 a, s9 _1 ]( ~- ]
54.             }
    # J( @  D. {8 \- ^" T% a
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    ' W' `  y* f. t1 q
56.                         /*==========记录数本地异常日志==========*/  
    ) q" B% i- k' j, |" }, e2 l
57.                         //LogUtil.error(description, e);
    
58.                         /*==========发送异常日志到邮箱==========*/
    
59.                         StringBuffer errorMsg = new StringBuffer();
    
60.                         errorMsg.append("异常方法:");
    3 N! W& R3 N+ V$ C  s4 n
61.                         errorMsg.append(method);
    
62.                         errorMsg.append("</br>");
    
63.                         errorMsg.append("异常类型代码:");
    $ F' p$ p6 j+ L; |1 z
64.                         errorMsg.append(exceptionCode);
    + z0 O6 S* ^2 U  T
65.                         errorMsg.append("</br>");
    
66.                         errorMsg.append("异常详细信息:");
    
67.                         errorMsg.append(exceptionDetail);
    
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    ! ^5 b: t1 i- M! ]7 [
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    . z* \- Y: Q. ^, t& Z
73.                         e.printStackTrace();
    ( c0 {( \" R0 m; |
74.                 }
    
75.     }
    5 \! l* O3 @% |
76.      /**
    
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    
78.       * @Author        张志朋
    4 }  w8 n9 z6 n6 O' R
79.       * @param joinPoint
      d! b5 |% c+ e8 H# J* E) Y
80.       * @return
    
81.       * @throws Exception  String
    ' V5 \# u! ~; p( c" M* h1 {) I
82.       * @Date        2015年6月3日
    ( l3 K; D' U6 t' G- d3 E% |
83.       * 更新日志
    
84.       * 2015年6月3日 张志朋  首次创建
    
85.       *
    ) y- X' k; C1 c
86.       */
    * m, ^( X, r* j0 y# Q! ?+ U
87.      @SuppressWarnings("rawtypes")
    ) j# U) @( |# A  R0 q4 T0 W- V
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    
89.              throws Exception {   
    
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    
91.         String methodName = joinPoint.getSignature().getName();   
    
92.         Object[] arguments = joinPoint.getArgs();   
    , Z4 _' f. b: B! V
93.         Class targetClass = Class.forName(targetName);   
    
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    ) h" l- A- \7 \" ^$ H/ ~5 p
96.          for (Method method : methods) {   
    0 O, v2 R& H1 l8 \: L! Q
97.              if (method.getName().equals(methodName)) {   
    * Z7 I1 M! Z3 S6 z2 T. z
98.                 Class[] clazzs = method.getParameterTypes();   
    4 p! z. ?0 h  h8 {% N# c- I! B  e
99.                  if (clazzs.length == arguments.length) {   
    
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     
101.                      break;   
     
102.                 }   
     % r  L. R: O6 Z; ?+ g
103.             }   
     ' f) R1 F( k  V; w! P1 O
104.         }   
     " Y8 `5 V% {, B2 O
105.          return description;   
     4 p4 o& \, `# C/ K7 I
106.     }
     , O) `2 N; D! C: c0 O; n
107.     }

复制代码

3 B+ K) _( @, l2 W0 i' r, |8 m& n这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
" H2 g3 V0 q! ~' ]4 edoAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。

% E( C; I- S5 n; K( Z8 J: l2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）

1. @ServiceLog(description="获取待审试题数量")
   
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   ! I4 |4 A: z) l3 Y/ S8 R4 S0 A/ k
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   
4.         }

复制代码

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

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

复制代码

(1)、定义注释：
1.Permission.java

1. /**
   & m3 f& v4 i7 _! V$ I, o: o
2. * 自定义权限管理
   & g  Q* @2 l6 P- y2 _* o) E+ q- h
3. * 创建者        张志朋
   , _4 s! N" F0 I; C7 p* J
4. * 创建时间        2015年6月30日
   
5. *
   
6. */
     Z" O) m) s1 h6 y
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   ' _% J( G4 T$ S2 c- `( T
8. @Retention(RetentionPolicy.RUNTIME)   
   
9. @Documented
   
10. public @interface Permission {
    
11.         String name()  default ""; //操作行为
    
12.         int id() default -1;//权限值
    
13. }

复制代码

(2)、定义切面以及切入点
1.PsemissionAspect.java
; e' ?/ I6 ]2 ?+ n( J7 W

1. /**
   4 H/ D5 g6 l1 G4 }5 A% N  X
2. * 权限管理
   
3. * 创建者        张志朋
   / U; u9 P$ G: S% A% l# w! h1 U8 ~
4. * 创建时间        2015年7月3日
   # I8 i8 m" w0 o' P2 S5 w
5. *
   
6. */
   
7. @Component
   
8. @Scope
   
9. @Aspect
   
10. public class PsemissionAspect {
    8 [9 ^. `. f" a1 }, W0 n1 l8 a
11.         
    & w" e" T/ `% q% c% ~" r( Z
12.     //Controller层切点 用于权限控制
    0 d- V  J  ^* |
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    - s6 _8 i( E- k3 I3 N
14.         public void permissionAspect() {
    
15.                
    
16.         }
    
17.         /**
    % ~+ l/ x3 ?# @( s# j1 M7 J
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    
19.          * @Author        张志朋
    . u/ _0 f/ O! y' E  u
20.          * @param joinPoint  void
    * I) {7 h* m# P
21.          * @Date        2015年6月3日
      b( u% v" M) S3 x
22.          * 更新日志
    
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    
25.          */
    
26.     @Around("permissionAspect()")   
    
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    
28.         Object retVal = null;
    
29.                 int role  =  getControllerMethodRole(joinPoint);
    9 ~4 [" {1 ^! R' q
30.                 TeacherEntity user = CommonUtil.getUser();
    1 P5 k1 d2 L5 }/ Q- C( m8 k  X2 m
31.                 if((user.getSpecRole()&role)==role){//没有权限
    
32.                         retVal  = joinPoint.proceed();
    , ?) M8 F8 c8 o# }
33.                 }else{
    7 C* y' ]+ t  L( r6 s6 `; F2 e
34.                         noAuthorization();
    
35.                 }
    3 z. H$ M5 |6 p
36.             return retVal;
    4 y& [5 X+ J$ f4 m: G) |
37.     }
    
38.     /**
    
39.      * 没有权限 实现跳转
    9 V8 ]+ m8 Y  F4 j
40.      * @Author        张志朋
    + O; Q& S* r, O0 |5 d
41.      * @throws IOException  void
    
42.      * @Date        2015年7月3日
    
43.      * 更新日志
    9 B" f) K6 e+ K, C
44.      * 2015年7月3日 张志朋  首次创建
    
45.      *
    
46.      */
    
47.     public void noAuthorization() throws IOException{
    ) S1 ]; U$ Y6 S
48.             HttpServletRequest request = ServletActionContext.getRequest();
    
49.                 String path =  request.getContextPath();
    
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    ; z: m! N, L: ~
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
      z: G. b4 a6 Q1 r+ ]
52.     }
    
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    
55.      * @Author        张志朋
    
56.      * @param joinPoint
    3 a) q3 s# B3 ^# z5 g
57.      * @return
    
58.      * @throws Exception  int
    ! o9 I! ^/ f: ?9 s1 Y5 u
59.      * @Date        2015年7月3日
    
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    % n, x. ]/ b6 w7 D& W% z+ |3 k
62.      *
    . m  L) U% S* X5 z# _
63.      */
    : U5 ~+ n" s# o: k! |0 T2 M' E
64.     @SuppressWarnings("rawtypes")
    
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
    
69.         Class targetClass = Class.forName(targetName);   
      R! _0 T8 q3 ]+ ]( Q5 p3 k7 E+ m
70.         Method[] methods = targetClass.getMethods();   
    - S# K# v; n7 A1 z8 Q* F  y: Q$ l1 l0 W
71.         int role = -1;   
    ( m) C  b5 x9 q+ a& e3 s; q
72.          for (Method method : methods) {   
    0 ?9 _' F' A  h/ |. y
73.              if (method.getName().equals(methodName)) {   
    8 ~" r* o6 w- m: X
74.                 Class[] clazzs = method.getParameterTypes();   
    * U# I8 A  b; o$ h% k
75.                  if (clazzs.length == arguments.length) {   
    ' y2 f' C7 m1 c/ |+ M: w' W. z
76.                          role = method.getAnnotation(Permission. class).id();   
    
77.                      break;   
    + F3 e0 M0 s% T4 ~; ~$ A' K; W
78.                 }   
    6 {# N/ x0 r- X+ C. K
79.             }   
    
80.         }   
    9 F7 y; e0 t, B% {* M8 [
81.          return role;   
    5 Z  C. f8 g& j- A3 J' h% A1 J* q
82.     }

复制代码

2.action层代码实现：

1. /**
   
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
   ! m3 S) q+ G; u5 Z9 c- v; j
4.          * @Date        2015年5月4日
   
5.          * 更新日志
   $ G  ?* {1 b! l( W7 U( ?* p
6.          * 2015年5月4日 张志朋  首次创建
   
7.          *
   4 f5 [9 f, u: d+ G$ L  q( _
8.          */
   & e% Z7 V) d+ ~8 K# j  G5 K, j- f
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   ( B' s" Y% s* J) R- Z8 \" i
10.         public void auditQuestions(){
    2 H) Z8 O8 K, x# f6 l0 @* f
11.                 try {
    
12.                      //代码实现
    ! m2 K; E$ [3 q# ~) h& T4 ?
13.                 } catch (Exception e) {
    
14.                      e.printStackTrace();
    
15.                 }
    . ~1 W1 M5 A" U( m7 A2 q0 x
16. 
    
17.         }

复制代码

$ R/ P7 d  n0 n0 h& N

共同研讨

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

共同研讨

不错的东西    支持下

gaoxiang1985

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

毛小豆

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

wfymqj

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

xiaohan

楼主威武，感谢楼主

java侠

感谢楼主分享，

贝斯特

感谢 分享  

明月照大江

不错，谢谢