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

admin

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

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

, _* J. Y% o. r一、 记录日志并发送邮件通知
1 g6 T/ {. l7 j5 {" f(1)、定义注解：
! r. Q5 j+ I# q/ W$ C1.ServiceLog.java(各种参数类型详见上面的资料)

1. import java.lang.annotation.*;
   ! j2 ]; H( O  w# v$ s/ R
2. /**
   
3. * 自定义注解 拦截service  
   ( N9 ~$ C. E  D3 T: _* M% c
4. * 创建者        张志朋
   ) T8 y. y( D9 w3 d* |
5. * 创建时间        2015年6月3日
   4 c1 [5 l: N: P$ S, ^7 j
6. *
   ) \2 P0 C% G  e' K
7. */
   4 a% ~- c% ^7 r3 I4 @) \1 M
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented   
    
11. public  @interface ServiceLog {
    
12.          String description()  default "";
    # b  I$ {- g: R
13. }

复制代码

2.ControllerLog.java
1 q+ D5 g5 j5 h% D# h# C

1. import java.lang.annotation.*;
   + b4 T# P: ?) O$ g& X5 [' K' \
2. /**
   $ G# A9 h3 u2 @) y3 ]; V
3. * 自定义注解 拦截Controller
   
4. * 创建者        张志朋
   
5. * 创建时间        2015年6月3日
   
6. *
   
7. */
   
8. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   , w5 i) J: d1 t
9. @Retention(RetentionPolicy.RUNTIME)   
   
10. @Documented
    ! C- I4 {. z" ]/ Y# Y# b! S7 _
11. public @interface ControllerLog {
    
12.         String description()  default "";
    
13. }

复制代码

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

1. /**
   
2. * 日志记录AOP
   ) M1 i, A! H4 v4 O  a0 i4 P8 ?
3. * 创建者        张志朋
   
4. * 创建时间        2015年6月3日
   
5. *
   * ^! ^& O7 B+ z  }% E& w3 e) d
6. */
   
7. @Component
   
8. @Scope
   
9. @Aspect
   
10. public class LogAspect {
    
11.         //Service层切点     用于记录错误日志
    
12.         @Pointcut("@annotation(com.web.aop.ServiceLog)")  
    : N' E* m* v6 i# m( E& I3 l
13.         public void serviceAspect() {
    & N- q9 s. Y  I( S5 M$ C
14.                
    
15.         }
    
16.     /**
    
17.      * 异常通知 用于拦截service层记录异常日志  
    " O' Y2 U- ~8 R  J) B
18.      * @Author        张志朋
    
19.      * @param joinPoint
    
20.      * @param e  void
    , x4 o+ V% W: M5 `' ]
21.      * @Date        2015年6月3日
    
22.      * 更新日志
    3 G3 U$ t3 Z. S" _9 [! n
23.      * 2015年6月3日 张志朋  首次创建
    ' W' R4 }; s: V4 ]+ _9 l3 z0 d
24.      *
    
25.      */
      H( T' h* K3 ?4 k
26.     @AfterThrowing(pointcut = "serviceAspect()", throwing = "e")   
    ! M  {1 f4 t( |2 Q9 J4 h( G% d
27.     public  void doAfterThrowing(JoinPoint joinPoint, Throwable e) {
    $ O  @/ I6 B: {# [; o: w. k( g+ E, o9 r
28.                 HttpServletRequest request = ServletActionContext.getRequest();
    7 _3 D$ d% E& ]0 [3 ]) K
29.                 TeacherEntity user = CommonUtil.getUser();
    
30.                 String ip = AddressUtils.getIpAddr(request);
    * z( M. T. v' T: v( a/ R
31.                 try {
    + _2 ~4 b$ X6 f. |
32.                         String params = "";
    
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]) + ";";
    
36.                                 }
    / d- \. [7 W* [# I8 F
37.                         }
    
38.                         String description = getServiceMthodDescription(joinPoint);//用户操作
    
39.                         String exceptionCode  =e.getClass().getName();//异常类型代码
    4 G0 j  ?" J! h; v1 s& o# t
40.                         String exceptionDetail = e.getMessage();//异常详细信息
    ' ?, ~6 T, j( K& N/ y( G; j
41.                         String method = joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + "()";//异常方法
    + q% d8 Z. j+ z% I
42.                         /*==========记录数据库异常日志==========*/  
    & g% l* T5 Z: M8 @9 ~; c7 d% l! X
43.                         Log log = new Log();
    
44.                         log.setDescription(description);
    
45.                         log.setExceptionCode(exceptionCode);
    
46.                         log.setExceptionDetail(exceptionDetail);
    
47.                         log.setMethod(method);
    0 [! [3 w7 |" f4 E6 S
48.                         log.setType(Constants.LOG_ERROE);// 日志类型
    
49.                         log.setRequestIp(ip);// 请求IP
    ! y% K* W; ?  u' e1 f
50.                         log.setParams(params);//请求参数
    
51.                         if(null!=user){
    8 x# Q! C  Y7 h/ `
52.                     log.setCreateUid(user.getUid());//用户ID
    
53.                     log.setCreateName(user.getNickname());//用户昵称
    
54.             }
    
55.                         log.setPlatFrom(Constants.SUBJECT_CODE);
    8 m% ]. R& A' R% Y/ p1 {
56.                         /*==========记录数本地异常日志==========*/  
    
57.                         //LogUtil.error(description, e);
    / \- s; P9 r5 k3 E% \9 F! i
58.                         /*==========发送异常日志到邮箱==========*/
    
59.                         StringBuffer errorMsg = new StringBuffer();
    % E+ I, b# i9 d3 v
60.                         errorMsg.append("异常方法:");
    
61.                         errorMsg.append(method);
    
62.                         errorMsg.append("</br>");
    6 C" j6 d" j& `% n! S  t' r
63.                         errorMsg.append("异常类型代码:");
    # X2 d% _* m& U) @0 G* `
64.                         errorMsg.append(exceptionCode);
    ; z4 R! u' J( k, Z4 x
65.                         errorMsg.append("</br>");
    ) L7 P9 I9 F- N* O9 p4 l5 n* o
66.                         errorMsg.append("异常详细信息:");
    ( n! Q  B) |* n0 [8 \$ N; }# ^
67.                         errorMsg.append(exceptionDetail);
    , L( ]+ B) \, P0 I; e  H8 N+ p
68.                         errorMsg.append("</br>");
    
69.                         log.setErrorMsg(errorMsg.toString());
    
70.                         WebServiceMathClient  Client = new WebServiceMathClient();
    
71.                         Client.sendError(log);
    
72.                 } catch (Exception ex) {
    5 m! n) G. S2 B) l9 j0 J' K
73.                         e.printStackTrace();
    6 b6 F" U2 D& t# j- i
74.                 }
    
75.     }
    
76.      /**
    
77.       * 获取注解中对方法的描述信息 用于service层注解  (基于反射)
    ) E/ M4 {6 u) k8 Y. I# P6 V) H" e
78.       * @Author        张志朋
    
79.       * @param joinPoint
    
80.       * @return
    + n/ |$ Q+ V; I! J
81.       * @throws Exception  String
    
82.       * @Date        2015年6月3日
    
83.       * 更新日志
    3 f  V- k7 x1 n1 c! `4 `: a5 l
84.       * 2015年6月3日 张志朋  首次创建
    
85.       *
    
86.       */
      _8 z1 o4 l# |% N* b
87.      @SuppressWarnings("rawtypes")
    
88.         public  static String getServiceMthodDescription(JoinPoint joinPoint)   
    / q6 q1 u- E8 \. C! f
89.              throws Exception {   
    , U. T7 [* T( k2 G& |
90.         String targetName = joinPoint.getTarget().getClass().getName();   
    
91.         String methodName = joinPoint.getSignature().getName();   
    
92.         Object[] arguments = joinPoint.getArgs();   
    
93.         Class targetClass = Class.forName(targetName);   
    
94.         Method[] methods = targetClass.getMethods();   
    
95.         String description = "";   
    
96.          for (Method method : methods) {   
    
97.              if (method.getName().equals(methodName)) {   
    % V2 t" C* ~. z$ w, J( U( Y9 t
98.                 Class[] clazzs = method.getParameterTypes();   
    - w1 b6 e. Z4 z5 _+ p
99.                  if (clazzs.length == arguments.length) {   
    
100.                     description = method.getAnnotation(ServiceLog. class).description();   
     $ N2 m. q. |; ~, B
101.                      break;   
     
102.                 }   
     
103.             }   
     
104.         }   
     
105.          return description;   
     9 w; e* a! L" a/ \; d% E
106.     }
     0 m0 F, L: R5 b  x9 I
107.     }

复制代码

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

2.QuesPerServiceImpl.java(注意此类必须实现接口 默认JDK的动态代理实现是基于接口实现的 否则会报错）

1. @ServiceLog(description="获取待审试题数量")
   
2. public long getAuditQuesNum(TeacherEntity currentUser) throws Exception {
   7 m9 V0 H1 i) z. j9 u5 W6 T% @
3.                 return quesPerDao.getAuditQuesNum(currentUser);
   0 y. l1 X- J. D4 ^  m" t5 n& H3 b" E. e
4.         }

复制代码

之所以定义description 描述 是为了更好的记录错误日志 文字总是比方法名 更容易识别。
6 r3 T8 `5 t* f( F8 ~3 O! k二、AOP实现权限控制
       上面说过使用动态代理的类 必须实现接口但是我们的action并没有实现接口。 JDK 的动态代理只能对实现了接口的目标类进行代理，而不实现接口的类就不能使用 JDK 的动态代理。
. T, e" d' u; r6 }) }. l! r        还好有第三方的包为我们解决了问题。项目中引入cglib.jar，CGLIB 是针对类来实现代理，当没有实现接口的类需要代理时就需要通过 CGLIB 来实现代理了，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但是因为采用的是继承，所以不能对 finall 类进行继承。
  _" M3 V' W& X" G0 l  i首先配置文件要引入这样一段配置(看注释说明)：
# r' Z. V: D: j0 q' W* E. b

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

复制代码

(1)、定义注释：
1.Permission.java
9 e; n: W0 B- h5 d

1. /**
   
2. * 自定义权限管理
   
3. * 创建者        张志朋
   & h! d* A' q3 j: x* R+ L0 }/ s
4. * 创建时间        2015年6月30日
   9 V" d/ G" Z2 Y1 A4 z
5. *
   - d6 G3 m7 d" m
6. */
   
7. @Target({ElementType.PARAMETER, ElementType.METHOD})   
   6 r( ?4 _% _6 Q4 M' n
8. @Retention(RetentionPolicy.RUNTIME)   
   
9. @Documented
   ' w- O7 q+ [6 J: e' V# Z
10. public @interface Permission {
    
11.         String name()  default ""; //操作行为
    ) X) r4 W2 y7 f- i
12.         int id() default -1;//权限值
    6 h: |# k6 S: U. l( n0 Z' U. G
13. }

复制代码

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

1. /**
   
2. * 权限管理
   9 n* ]9 f% |7 z1 z  Z4 H
3. * 创建者        张志朋
   2 ?, A# V4 f8 H1 Q0 i
4. * 创建时间        2015年7月3日
   
5. *
   
6. */
   ' k; Z' C7 ~* u4 F% f+ f
7. @Component
   
8. @Scope
   
9. @Aspect
   * _  @6 ?2 G. M$ ]
10. public class PsemissionAspect {
    
11.         
    
12.     //Controller层切点 用于权限控制
    + r2 i3 G  }% a  J  T- \" S$ U
13.         @Pointcut("@annotation(com.acts.web.aop.Permission)")  
    ) a  f1 E. W% M5 `3 D( Q3 t; h1 M
14.         public void permissionAspect() {
    
15.                
    / K& j. G2 C2 d! ^1 u6 C. m0 `
16.         }
    / r& c" e* q* P6 V5 u5 a
17.         /**
    # {* N4 l1 |/ f, M4 p  R$ u
18.          * 用于拦截Controller层用户操作权限(环绕通知)
    
19.          * @Author        张志朋
    ) m! p) k* q% u- \
20.          * @param joinPoint  void
    ' `3 W  B' `8 B2 e: M2 P1 H% f
21.          * @Date        2015年6月3日
    
22.          * 更新日志
    0 [0 I! [- B. s1 b" X
23.          * 2015年6月3日 张志朋  首次创建
    / b" s% g% f# {1 S3 B$ T! n
24.          *
    
25.          */
    
26.     @Around("permissionAspect()")   
    * {. C. A# x" ^0 F* T9 ?
27.     public  Object permission(ProceedingJoinPoint  joinPoint)throws Throwable {  
    
28.         Object retVal = null;
    
29.                 int role  =  getControllerMethodRole(joinPoint);
    
30.                 TeacherEntity user = CommonUtil.getUser();
    7 N% Q& y: j2 Y' E
31.                 if((user.getSpecRole()&role)==role){//没有权限
    3 Y" k! {3 v* S5 w
32.                         retVal  = joinPoint.proceed();
    
33.                 }else{
    
34.                         noAuthorization();
    
35.                 }
    , n7 j: c* e# d3 d. ^
36.             return retVal;
    
37.     }
    
38.     /**
    8 d  i, t3 v2 q  j- ~2 d) L
39.      * 没有权限 实现跳转
    
40.      * @Author        张志朋
    ' }; a+ `& l4 B: K- W3 g
41.      * @throws IOException  void
    6 l4 g$ i9 P: U- {& z- Q
42.      * @Date        2015年7月3日
    / _, H0 y# z5 Q' Z$ ?6 h. u
43.      * 更新日志
    
44.      * 2015年7月3日 张志朋  首次创建
    
45.      *
    
46.      */
    
47.     public void noAuthorization() throws IOException{
    4 Q: ?0 t+ Q; Z& d& J; V% U
48.             HttpServletRequest request = ServletActionContext.getRequest();
    
49.                 String path =  request.getContextPath();
    
50.                 HttpServletResponse response  = ServletActionContext.getResponse();
    $ n5 j$ r% x- o7 A
51.                 response.sendRedirect(path+"/pages/noAuthorization.jsp");
    
52.     }
    6 E, q$ B' V  a' G, O7 W
53.     /**
    
54.      * 获取注解中对方法的权限值 用于Controller层注解  
    
55.      * @Author        张志朋
    " D3 N0 }: L: \- u6 r* \9 q/ S6 Z6 N
56.      * @param joinPoint
    
57.      * @return
    4 h2 b& p, _0 K% _$ y, S8 K* b
58.      * @throws Exception  int
    9 d- [+ |8 V* A! E* G4 R* ]9 E
59.      * @Date        2015年7月3日
    5 c) e* O1 v6 b- ^' D0 R2 D
60.      * 更新日志
    
61.      * 2015年7月3日 张志朋  首次创建
    
62.      *
    
63.      */
    
64.     @SuppressWarnings("rawtypes")
    ) N) Z8 C, G/ M( s, v
65.         public  static int getControllerMethodRole(JoinPoint joinPoint)  throws Exception {
    
66.         String targetName = joinPoint.getTarget().getClass().getName();   
    3 s# z  E4 I5 h( e! H$ H* @
67.         String methodName = joinPoint.getSignature().getName();   
    0 m5 P7 P+ E3 L- M0 f$ k! \3 h
68.         Object[] arguments = joinPoint.getArgs();   
    
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) {   
    ! G" ?, ?$ v. p5 g# U% y
76.                          role = method.getAnnotation(Permission. class).id();   
    
77.                      break;   
    " e7 K5 Y6 }& G( L+ P3 a! s
78.                 }   
    
79.             }   
    
80.         }   
    
81.          return role;   
    
82.     }

复制代码

" J& q, c7 q. L) `4 m! w2.action层代码实现：
  [  s7 [& A- k* V; x  a6 f

1. /**
   3 E( \+ a# T2 _' j5 I! T4 d! g
2.          * 试题审核不通过
   
3.          * @Author        张志朋  void
   " R; R* h9 E. W0 ^
4.          * @Date        2015年5月4日
   2 d. O( U6 \6 I; r8 Y! n
5.          * 更新日志
   
6.          * 2015年5月4日 张志朋  首次创建
   
7.          *
   * J% f+ W3 ~, l- W+ Y: Q
8.          */
   / T2 R5 x% Q7 B2 n$ r0 f2 Y0 E
9.         @Permission(name="审核试题权限(审核不通过)",id=Constants.ROLE_QUES_AUDIT)
   : x2 ^% F% P& O' \- v1 U3 I. Q
10.         public void auditQuestions(){
    
11.                 try {
    
12.                      //代码实现
    4 \1 W9 h! c' }# Z  n& r9 e
13.                 } catch (Exception e) {
    
14.                      e.printStackTrace();
    
15.                 }
    
16. 
    
17.         }

复制代码

5 l) e, g# Q: f

zcl001001

学习学习，参考下开发

zrszrs

x'x'x'x'x'x'x

奈何、

学习学习。

劉様

不错不错

花生壳

花生壳到此一逛

春天

好东西            谢谢分享

辉大大

很不错很不错很不错很不错很不错很不错很不错

我的老家

admin 发表于 2016-11-23 13:24
' e# Q: s0 _& ~5 Y% Y0 p! D1 }0 l有

+ B# q9 H' I( [$ B好的 谢谢了  麻烦你了

淡定240

不错，受用了，谢谢分享

admin

我的老家 发表于 2016-11-23 02:55
有没有发送邮件的功能？

有