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

admin

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

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

7 U8 w: Y5 C3 r9 i) F# W6 ]* I       鉴于项目中配置了数据库事务，其实也是使用了AOP 详见applicationContext-service.xml配置文件。由于配置文件的局限性这里采用注释的方式实现。之所有使用注释是可以自定义参数并实现日志的详细记录。既然使用注释，现成的没有，只有自己定义来实现需求。其实spring 注释实现的注入、hibernate的model类注释实现与数据库关联以及我们最常见Override。
       资料:java如何实现自定义注释http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html
/ R* n9 k/ m6 Q6 h% {
! e+ P4 f+ J% ]% l7 X+ M一、 记录日志并发送邮件通知
" |: g) b5 |' X( o( Q+ Z) C/ K(1)、定义注解：
, X' Y8 F6 Z8 I/ |) S! C0 _1.ServiceLog.java(各种参数类型详见上面的资料)

1. import java.lang.annotation.*;
   5 m' s# m% w, a5 T& E& }
2. /**
   9 t( B' H/ O% D
3. * 自定义注解 拦截service  
   # h+ O* B# s7 @+ m) ]& n6 b, @
4. * 创建者        张志朋
   8 @. n, ~  K3 I  @
5. * 创建时间        2015年6月3日
   
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    
11. public  @interface ServiceLog {
    5 o6 @  F0 g4 O2 c
12.          String description()  default "";
    ; i7 w& @( A1 I! V  N
13. }

复制代码

2.ControllerLog.java
8 z- {/ I0 R! k4 b2 p& T2 J

1. import java.lang.annotation.*;
   
2. /**
   
3. * 自定义注解 拦截Controller
   
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   
6. *
   ! k* K; s% p8 z$ s5 o
7. */
   * j- A" V: g+ }4 U- d2 ]
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   8 E5 ^( Q7 @! C1 f' G" L$ ?
9. @Retention(RetentionPolicy.RUNTIME)   
   3 a( K; M+ H% Z7 H% ?! N( v
10. @Documented
    
11. public @interface ControllerLog {
    
12.         String description()  default "";
    
13. }

复制代码

(2)、定义切面以及切入点
+ S3 R& \9 {6 g! p) P2 q1.LogAspect.java
7 S8 X  Q4 |' i8 N: o

1. /**
   8 G% Y  u+ k+ }. I
2. * 日志记录AOP
   4 {! {1 A! o- R2 R( B
3. * 创建者        张志朋
   4 v5 A/ A! S. d$ Y, e4 i
4. * 创建时间        2015年6月3日
   ; I6 Q8 F3 q6 R
5. *
   
6. */
   1 E/ V% k( b& _+ p3 k' ?* H
7. @Component
   
8. @Scope
   ) {( o) F4 I$ a9 k. V' R! J, i
9. @Aspect
   
10. public class LogAspect {
    
11.         //Service层切点     用于记录错误日志
    
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    ( \# p7 V2 Q( g" y- `& H/ l; D
13.         public void serviceAspect() {
    ( O7 \; M' i5 R+ N  f2 |3 g
14.                
    0 H- S8 y: b* P* d
15.         }
    
16.     /**
    . {0 T1 W4 [' u; ]
17.      * 异常通知 用于拦截service层记录异常日志  
    
18.      * @Author        张志朋
    ( I  c9 N1 G) Z! z
19.      * @param joinPoint
    % {# k0 z" B+ m; p# X
20.      * @param e  void
    
21.      * @Date        2015年6月3日
    
22.      * 更新日志
    # o/ F+ G9 f: F' Z$ ]
23.      * 2015年6月3日 张志朋  首次创建
    ) i/ z' N/ r3 b3 w" M
24.      *
    
25.      */
    0 ^5 E: x: N3 D! ^6 S; t# y) k
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    % u# {8 W; `" F9 B0 |, N; T5 ?
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    5 X; ^% z9 M0 X" a# S
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    : I5 J) G. T" _0 t! m
29.                 TeacherEntity user = CommonUtil.getUser();
    - A% A- T1 f$ j4 e: }
30.                 String ip = AddressUtils.getIpAddr(request);
    
31.                 try {
    5 j% [2 ^0 b5 T2 d$ t( x
32.                         String params = "";
    
33.                         if (joinPoint.getArgs() != null && joinPoint.getArgs().length > 0) {
    ! X4 q+ J+ z0 b. m7 k2 }
34.                                 for (int i = 0; i < joinPoint.getArgs().length; i++) {
    
35.                                         params += JSONUtil.toJSONstring(joinPoint.getArgs()[i]) + ";";
    / V6 S- D' N2 {# t" z
36.                                 }
    7 X9 ^: K. X; q
37.                         }
    ' T* `2 \/ k+ z- D% R
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
      f8 L0 \! u  I. L! Q5 x. K
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    & [# |- H* a6 r* Q
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    7 T1 C* M: n9 }" ?3 b; Q6 G* ^
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    * s& P7 g' d1 R
42.                         /*==========记录数据库异常日志==========*/  
    ! }# B4 |$ ^; D: p; J
43.                         Log log = new Log();
    3 A7 M7 e" ~6 j" {: d" l
44.                         log.setDescription(description);
    
45.                         log.setExceptionCode(exceptionCode);
    
46.                         log.setExceptionDetail(exceptionDetail);
    
47.                         log.setMethod(method);
    
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    
50.                         log.setParams(params);//请求参数
    
51.                         if(null!=user){
    
52.                     log.setCreateUid(user.getUid());//用户ID
    
53.                     log.setCreateName(user.getNickname());//用户昵称
    4 f6 J/ M, b7 G0 R' k6 n$ x
54.             }
    
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    
56.                         /*==========记录数本地异常日志==========*/  
    ' R& v/ O& W$ s' A! H2 U
57.                         //LogUtil.error(description, e);
    * C4 r, E- S- w& D
58.                         /*==========发送异常日志到邮箱==========*/
    - f% x  N2 C, e6 l! \+ d
59.                         StringBuffer errorMsg = new StringBuffer();
    
60.                         errorMsg.append("异常方法:");
    ) N* K/ L; C* ^
61.                         errorMsg.append(method);
    , _( [' M$ y% H+ L  u- m# ~
62.                         errorMsg.append("</br>");
    
63.                         errorMsg.append("异常类型代码:");
    8 U; r0 C% ^% g. y( e0 }' ?, f! {
64.                         errorMsg.append(exceptionCode);
    , `+ w8 n/ Q( g" C
65.                         errorMsg.append("</br>");
    
66.                         errorMsg.append("异常详细信息:");
    
67.                         errorMsg.append(exceptionDetail);
    
68.                         errorMsg.append("</br>");
    9 f1 [: ^( f1 H
69.                         log.setErrorMsg(errorMsg.toString());
    + M  |9 @  ]3 r6 U
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    3 ?, l0 y6 L/ {( N/ v
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    + u) g4 `; h) R7 e2 F# b
73.                         e.printStackTrace();
    ( L( c( b. h4 q8 M
74.                 }
    ' ]% Y0 y0 x. _) I
75.     }
    
76.      /**
    * Z1 [) H0 g7 D( J) ]8 Q7 |
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    
78.       * @Author        张志朋
    0 Y, E; e, I+ L% A2 k+ @' y" V) N
79.       * @param joinPoint
    ) \$ B2 W3 _! D
80.       * @return
    $ A' V9 `  Y; q; G, U, H/ D$ Q& Q
81.       * @throws Exception  String
    6 X! N# x% \2 `9 U2 P
82.       * @Date        2015年6月3日
    
83.       * 更新日志
    " W& W2 @/ z! |  R  f
84.       * 2015年6月3日 张志朋  首次创建
    
85.       *
    
86.       */
      b& K7 {* y6 ]2 D* X7 x+ w
87.      @SuppressWarnings("rawtypes")
    : ]& J' s8 q9 d+ w, m
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    - h+ [4 v: [( p/ `' s. [5 p6 V
89.              throws Exception {   
    
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    
91.         String methodName = joinPoint.getSignature().getName();   
    ! A8 A; a! Z% f5 Z# b  e
92.         Object[] arguments = joinPoint.getArgs();   
    
93.         Class targetClass = Class.forName(targetName);   
    % r. u! T% t- P$ ]. [
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    
96.          for (Method method : methods) {   
    7 X# i* b* C: |% z* ]
97.              if (method.getName().equals(methodName)) {   
    # J( b* ?3 x' w8 f9 f0 m6 X
98.                 Class[] clazzs = method.getParameterTypes();   
    6 e2 f0 R7 U& T  e* m& o6 A
99.                  if (clazzs.length == arguments.length) {   
    : v# g: W$ n( l: c
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     
101.                      break;   
     ; y( Y7 \" a3 W& Y: s8 G
102.                 }   
     8 {0 t3 P% j1 x9 B" w6 g! L
103.             }   
     
104.         }   
     
105.          return description;   
     
106.     }
     / k) N5 Y+ S" p2 T
107.     }

复制代码

这里说明一下  serviceAspect()方法 上面注释了 @Pointcut("@annotation(com.acts.web.aop.ServiceLog)")  、也就说明这是一个切入点，springAOP对其进行了封装。
9 o# z# @# E: h. q+ g2 odoAfterThrowing()方法上面加入了@AfterThrowing(pointcut = "serviceAspect()", throwing = "e") 对切入点的所有异常信息进行处理(记录日志到数据库或者发送错误信息到指定邮箱等等等，可以做任何你想做的事情)。

2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）
( m. L: h, W0 `. H& C0 n

1. @ServiceLog(description="获取待审试题数量")
   : @$ P8 y' O& _" N
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   8 R2 o* D$ ^$ ]6 p5 N5 Q
4.         }

复制代码

0 {! x8 m4 G" L% z" ?之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
二、AOP实现权限控制
       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
2 C- q# U: z# [4 Q/ A: y. \        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
3 d5 Z0 _  u4 \1 @' o首先配置文件要引入这样一段配置(看注释说明)：
& X" d9 X' z* j/ g4 ~. b

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

复制代码

# `9 S$ z6 w0 _4 ]6 r8 i(1)、定义注释：
, f7 m7 T8 F" Y8 l/ V6 w1.Permission.java
4 J) }( A. T0 K4 C' k$ C5 }0 W, {

1. /**
   ( w8 J& m) j( H& v7 P6 ^
2. * 自定义权限管理
   
3. * 创建者        张志朋
   : ~& O2 v+ P5 H, t
4. * 创建时间        2015年6月30日
   ! Q. N, T. b& ]3 R5 W: x
5. *
   
6. */
   * K/ x' ?6 S" k2 H% ?: @
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   ) J" n+ b" \. v+ i7 k$ V0 N* Q; ^
8. @Retention(RetentionPolicy.RUNTIME)   
   
9. @Documented
   6 r% y: r4 R+ h2 M2 P' `3 [$ s
10. public @interface Permission {
    
11.         String name()  default ""; //操作行为
    & g0 @( n2 l3 z3 N/ R' E# _, }0 r0 f
12.         int id() default -1;//权限值
    & T% ]4 A3 E3 a- Z! o( U8 i
13. }

复制代码

(2)、定义切面以及切入点
# \* x; b+ K) X# ^3 T, B1.PsemissionAspect.java

1. /**
   
2. * 权限管理
   " H. C* k7 [3 s% J9 e9 o0 K
3. * 创建者        张志朋
   % Q0 A& |0 O, g$ a) ^
4. * 创建时间        2015年7月3日
   & Y* I& s( a  p" E% D
5. *
   
6. */
   + x$ l$ q2 n% g: F
7. @Component
   1 ^8 _/ x  _* O# C/ e4 F
8. @Scope
   
9. @Aspect
   
10. public class PsemissionAspect {
    
11.         
    
12.     //Controller层切点 用于权限控制
    6 G& Q8 Y2 q/ Q' x
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    
14.         public void permissionAspect() {
    
15.                
    + \2 u2 ?: Y: l3 x% D, B
16.         }
    4 n$ Y9 `& J/ `+ ]" L
17.         /**
    
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    
19.          * @Author        张志朋
    
20.          * @param joinPoint  void
    9 N& b4 z) V/ [9 U' O
21.          * @Date        2015年6月3日
    ) n& G$ O* Q# s4 X
22.          * 更新日志
    * [4 R( M8 U4 p* W- u& o: `
23.          * 2015年6月3日 张志朋  首次创建
    
24.          *
    
25.          */
    9 [) m; j$ b5 Q* ~" z9 g
26.     @Around("permissionAspect()")   
    
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    0 v! w9 Y1 h  D0 K. y1 @( d! a2 ^
28.         Object retVal = null;
    
29.                 int role  =  getControllerMethodRole(joinPoint);
    
30.                 TeacherEntity user = CommonUtil.getUser();
    ! P* i! ?4 t+ N
31.                 if((user.getSpecRole()&role)==role){//没有权限
    ! e5 w, ]; X0 O
32.                         retVal  = joinPoint.proceed();
    ! q4 d% Z" X: P) u
33.                 }else{
    3 W. g. w, A5 X" w% O
34.                         noAuthorization();
    
35.                 }
    
36.             return retVal;
    : v- e! h# Q* o" t
37.     }
    7 r8 N6 `* e; v9 ~
38.     /**
    & A9 }, Q4 U8 M9 {7 K6 ?; n
39.      * 没有权限 实现跳转
    
40.      * @Author        张志朋
    
41.      * @throws IOException  void
    
42.      * @Date        2015年7月3日
    & d! y( M/ y5 n$ ^
43.      * 更新日志
    ' R$ d8 ]0 W/ s7 F/ J
44.      * 2015年7月3日 张志朋  首次创建
    0 l/ C% l$ p. ~
45.      *
    
46.      */
    
47.     public void noAuthorization() throws IOException{
    8 a8 Y% [" r0 `+ B& e* v
48.             HttpServletRequest request = ServletActionContext.getRequest();
    
49.                 String path =  request.getContextPath();
    
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    % F% v& o! g: @4 f5 ]
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    3 p- ~4 A& h' s; c1 f3 d8 C
52.     }
    
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    & z* G; z) e6 {$ |' i# M7 B. f' R
55.      * @Author        张志朋
    
56.      * @param joinPoint
    ' ~( C' ]8 @+ h. h+ ^4 a- G
57.      * @return
    
58.      * @throws Exception  int
    
59.      * @Date        2015年7月3日
    0 n& C3 M9 f9 n/ x! q# g
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    
62.      *
    
63.      */
    4 j4 c) W3 H$ \3 s, F
64.     @SuppressWarnings("rawtypes")
    
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    # Z& A& r% s0 G# d
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    
67.         String methodName = joinPoint.getSignature().getName();   
    
68.         Object[] arguments = joinPoint.getArgs();   
      e" J' N+ n/ V' `2 a) n
69.         Class targetClass = Class.forName(targetName);   
    / t5 {- h5 M+ \: }
70.         Method[] methods = targetClass.getMethods();   
    
71.         int role = -1;   
    # c9 }5 f$ ]# ?+ B  }
72.          for (Method method : methods) {   
    
73.              if (method.getName().equals(methodName)) {   
    ' J! R9 h  ~) t6 Z0 b6 r2 v$ t: s+ W
74.                 Class[] clazzs = method.getParameterTypes();   
    
75.                  if (clazzs.length == arguments.length) {   
    2 q3 U; m' j+ L3 M1 j1 v( R- K
76.                          role = method.getAnnotation(Permission. class).id();   
    * N/ k; G) P: c% h3 ?
77.                      break;   
    ) {  E/ R+ O* h
78.                 }   
    + d. ]& I2 a2 i2 ~9 h) z' C( ~
79.             }   
    6 [7 b+ V1 \: E* I
80.         }   
    
81.          return role;   
    / m" v6 o3 Q/ ^' N
82.     }

复制代码

! N9 n' a/ Y7 d% ~- F2.action层代码实现：

1. /**
   
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
     G& M6 b/ E* s2 d
4.          * @Date        2015年5月4日
   $ a1 V: f3 e2 k; d, {( [8 I
5.          * 更新日志
   7 k$ a% W3 s( A7 p$ T1 D
6.          * 2015年5月4日 张志朋  首次创建
   7 A; l0 P, A1 B
7.          *
   
8.          */
   $ z- d8 b% I4 O. Y
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   0 B$ q. R$ V3 J0 ^5 G
10.         public void auditQuestions(){
    
11.                 try {
    * v8 D; j- ~8 Q
12.                      //代码实现
    
13.                 } catch (Exception e) {
    . i" N. T5 ]1 `0 C
14.                      e.printStackTrace();
    
15.                 }
    
16. 
    - F% ^" {* n9 j  o+ u
17.         }

复制代码

& Q0 a) C9 a4 X: |9 e+ X9 Z

共同研讨

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

共同研讨

不错的东西    支持下

gaoxiang1985

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

毛小豆

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

wfymqj

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

xiaohan

楼主威武，感谢楼主

java侠

感谢楼主分享，

贝斯特

感谢 分享  

明月照大江

不错，谢谢