SpringBoot AOP 自定义参数转换

╰半夏微凉° 2022-12-22 06:12 277阅读 0赞

### 文章目录 ###

*   *  目标
     *  自定义注解
     *  AOP实现
     *  使用

## 目标 ##

有时候会有一些常用入参转换和出参转换需求，比如数据库存入的参数与页面不同，在请求参数去数据库查询时需要作一层参数转换，而返回给前端也需要作参数转换，为了不将这种常用冗余代码重复写入，希望自定义注解实现自动转换。  
下面代码仅供参考

## 自定义注解 ##

/** * @author : wh * @date : 2020/10/28 14:15 * @description: 参数转换 */
    @Documented
    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface TypeTansForm { 
    
        /** * 入参属性 * @return */
        String field() default "lType";
    
        /** * 返回值属性 * @return */
        String result() default "lType";
    
    }

## AOP实现 ##

这里是基于环绕通知，一个简单demo  
在方法执行前拦截对入参转换，在方法执行后拦截对返回结果作参数转换，所以使用环绕通知  
自己使用可在此demo上作相应的扩展

/** * @author : wh * @date : 2020/10/28 14:15 * @description: */
    @Aspect
    @Component
    @Slf4j
    public class TypeTansFormAspect { 
    
    
        @Pointcut("@annotation(com.sinoxk.drug.common.annotation.TypeTansForm)")
        private void fun() { 
        }
    
        @Around("fun()")
        public Object doAfter(ProceedingJoinPoint joinPoint) throws Exception{ 
            MethodSignature methodSignature = (MethodSignature)joinPoint.getSignature();
            Method method = methodSignature.getMethod();
            TypeTansForm typeTansForm = method.getAnnotation(TypeTansForm.class);
            // 获取注解属性名
            String fieldAnnotation = typeTansForm.field();
            //获取所有的参数
            Object[] targets = joinPoint.getArgs();
            rXTransfrom(targets, fieldAnnotation);
            // 方法返回值
            Object result = null;
            //返回值注解
            String resultAnnotation = typeTansForm.result();
            try { 
                result = joinPoint.proceed();
            } catch (Throwable throwable) { 
                throwable.printStackTrace();
            }
            if (Objects.isNull(result)) { 
                return null;
            }
                // 是否分页对象 PageInfoVO 为自定义分页对象
            if (result instanceof PageInfoVO) { 
                List<?> list = ((PageInfoVO<?>) result).getList();
                //出参转换
                list.forEach(s -> transfromToRX(s, resultAnnotation));
            }
            return result;
    
        }
    
        /** * 是否存在属性 * @param fieldName 属性名 * @param clazz 类 * @return boolean * @author wh * @date 2020/11/17 */
        public static boolean isExistFieldName(String fieldName, Class clazz){ 
            boolean flag = false;
            //获取这个类的所有属性
            Field[] fields = clazz.getDeclaredFields();
            //循环遍历所有的fields
            for (int i = 0; i < fields.length; i++) { 
                if (fields[i].getName().equals(fieldName)) { 
                    flag = true;
                    break;
                }
            }
            return flag;
        }
    
    
        /** * 入参转换 * @param targets 入参属性 * @param fieldAnnotation 注解属性 * @return void * @author wh * @date 2020/11/17 */
        private void rXTransfrom(Object[] targets, String fieldAnnotation) { 
            // 获取第一个参数
            Object target = Arrays.stream(targets).findFirst().orElse(new Object());
            Class<?> clazz = target.getClass();
            try { 
                if (isExistFieldName(fieldAnnotation, clazz)) { 
                    // 获取属性名
                    Field field = clazz.getDeclaredField(fieldAnnotation);
                    //设置属性为可访问
                    field.setAccessible(true);
                    String lType = field.get(target).toString();
                    if (Constant.RXName.equalsIgnoreCase(lType)) { 
                        field.set(target, Constant.RX);
                    } else if (Constant.OTCName.equalsIgnoreCase(lType)) { 
                        field.set(target, Constant.OTC);
                    }
                }
            } catch (Exception e) { 
                // 不做任何处理
            }
    
        }
    
    
    
        /** * 返回值转换 * @param object 目标对象 * @param resultAnnotation 注解属性 * @return void * @author wh * @date 2020/11/17 */
        private void transfromToRX(Object object, String resultAnnotation) { 
            Class clazz = object.getClass();
            try { 
                if (isExistFieldName(resultAnnotation, clazz)) { 
                    Field field1 = clazz.getDeclaredField(resultAnnotation);
                    field1.setAccessible(true);
                    String lType = field1.get(object).toString();
                    if (Constant.RX.equalsIgnoreCase(lType)) { 
                        field1.set(object, Constant.RXName);
                    } else if (Constant.OTC.equalsIgnoreCase(lType)) { 
                        field1.set(object, Constant.OTCName);
                    }
                }
            } catch (Exception e) { 
                e.printStackTrace();
            }
    
        }
    
    
    
    
    }

## 使用 ##

在 serviceImpl 加上注解即可完成入参与返回结果的自动转换

@Override
        @TypeTansForm(field ="bigType")
        public boolean updateCustomerLabel(CustomerLabelMapping labelMapping) { 
            return customerLabelMappingDao.update(labelMapping);
        }