【Java开发-Nutz】Nutz框架下如何添加自定义注解

Nutz框架下如何添加自定义注解

Nutz本身是个很不错的国产框架，轻量级、上手快，感兴趣的小伙伴可以去参考官网文档学习，使用，Nutz栏目主要是用于日常工作积累、备忘和分享。

前言

Nutz‌是一个轻量级的Java开发框架，遵循Apache协议，完全免费且开源。它提供了一系列轻量级的组件，包括DAO（对象关系映射）、Ioc（控制反转）、AOP（面向切面编程）、Mvc（模型-视图-控制器）和Json解析等功能，适用于各种开发场景，如服务器、Android和嵌入式开发等‌。

Nutz的特点包括：

• 轻量级‌：最新版本的Nutz jar文件大小为910kB，针对JDBC的封装非常薄，没有缓存，适合快速开发和部署‌。
• 功能全面‌：提供了DAO、Ioc、Aop、Mvc、Json解析等必要功能，可以独立使用各个部分，例如在Spring框架中使用Nutz.Dao‌。
• 无依赖‌：Nutz的所有功能均不依赖第三方jar文件，这意味着在一个Web应用中，只需要放置一个nutz.jar即可‌。
  Nutz是一个轻量级、功能全面的Java开发框架，适合需要快速开发和部署的项目

自定义注解实现

我们知道，即使在我们常用的Spring框架中，想要实现自定义注解也需要通过Aop来实现，在Nutz框架中也是一样的。

定义自己的注解

@Retention(RetentionPolicy.RUNTIME) // 必须带这个,不然读取不到的
@Target({ElementType.METHOD}) // aop,一般指方法
@Documented // 记录到javadoc
public @interface SysLog {
    /**
     *
     * action()解释说明：
     * 这个是我们写注解时需要传入的参数值的名称，比如上述的用的是action，
     * 那么我们在注解时就应该这样注解@SysLog (action=”测试”)，
     * 当然如果你只有一个参数需要传的，那么建议各位使用value(),这样注解时会默认传入的，
     * 这样我们就可以向其他注解一样@SysLog (“测试”)。
     * targetType()解释说明：自定义,我这边是分为save、delete、update、select
     * remark() ： 特殊信息备注
     */
    String action() default "";
    String targetType() default "";
    String remark() default "";
}

继承SimpleAopMaker

继承aop模块中的SimpleAopMaker扩展类，实现自己的LogAopLoader

public class LogAopLoader extends SimpleAopMaker<SysLog> {

	//功能模块
    private static final String LOG_TARGET_TYPE="targetType";
    //功能
    private static final String LOG_ACTION="action";
    //备注
    private static final String LOG_REMARK="remark";

    public List<? extends MethodInterceptor> makeIt(SysLog sysLog, Method method, Ioc ioc) {
        return Arrays.asList(new SysLogMethodInterceptor(sysLog));
    }
}

实现MethodInterceptor

实现自己的MethodInterceptor类，SysLogMethodInterceptor拦截器，完成自己的注解业务逻辑

public class SysLogMethodInterceptor implements MethodInterceptor {

    private final SysLog sysLog;

    private static final Log log = Logs.get();

    public void filter(final InterceptorChain chain){
        long startTime = System.currentTimeMillis();
        UaLogService uaLogService = Mvcs.getIoc().get(UaLogService.class);
        HttpSession session = Mvcs.getHttpSession();
        //创建日志对象 sysLog
        SysLogInfo log = new SysLogInfo();
        if(session != null){
            SysUser sysUser = (SysUser)session.getAttribute(CommonConstants.USER);
            if(sysUser != null){
                log.setUserId(String.valueOf(sysUser.getUserId()));
                log.setOperator(sysUser.getDisplayName());
            }
        }
        log.setAction(sysLog.action());
        log.setTargetType(sysLog.targetType());
        log.setRemake(sysLog.remark());
        HttpServletRequest request = Mvcs.getReq();
        log.setIp(getCliectIp(request));
        log.setPathUrl(request.getServletPath());
        log.info("请求参数 -->"+ getParamsByArgs(chain));
        try {
            chain.doChain(); // 继续下一个拦截器, 如果要终止执行,不调用该方法即可
            log.setIfSuccess("1");
        } catch (Throwable e) {
            e.printStackTrace();
            log.setIfSuccess("0");
            log.setErrorMsg(e.getMessage());
            log.error("error:"+e.getMessage());
        }
        long endTime = System.currentTimeMillis();
        log.setCompleteTime(String.valueOf(endTime-startTime));
        log.info("执行结果 -->" + chain.getReturn());
        uaLogService.saveLog(log);
    }

    private List<String> getParamsByArgs(InterceptorChain chain){
        Object[] paramsArgsValues = chain.getArgs();
        List<String> list = new ArrayList<>();
        for (Object obj:paramsArgsValues) {
            if(obj instanceof HttpServletRequest || obj instanceof HttpServletResponse || obj instanceof HttpSession){
                list.add(obj.toString());
            }else if(obj instanceof String){
                if(EmptyUtils.isNotEmpty(obj.toString())){
                    list.add(obj.toString());
                }
            }else {
                if(EmptyUtils.isNotEmpty(obj)){
                    list.add(Json.toJson(obj));
                }
            }
        }
        return list;
    }

    public SysLogMethodInterceptor(SysLog sysLog) {
        this.sysLog = sysLog;
    }


    private String getCliectIp(HttpServletRequest request){
        String ip = request.getHeader("X-Real-IP");
        if (!StringUtils.isEmpty(ip) && !"unknown".equalsIgnoreCase(ip)) {
            return ip;
        }
        ip = request.getHeader("X-Forwarded-For");
        if (!StringUtils.isEmpty(ip) && !"unknown".equalsIgnoreCase(ip)) {
            // 多次反向代理后会有多个IP值，第一个为真实IP。
            int index = ip.indexOf(',');
            if (index != -1) {
                return ip.substring(0, index);
            } else {
                return ip;
            }
        } else {
            return request.getRemoteAddr();
        }
    }

}

关于Nutz的使用，后续会慢慢积累分享，有兴趣的小伙伴，欢迎在本文下评论探讨，或者可以到Nutz官网社区咨询、探讨！！！