SpringBoot拦截器+注解方式实现防止表单重复提交

表单重复提交在web应用中是比较常见的问题，重复提交的动作容易造成脏数据，为了避免这重复提交的操作简便的方便是采用拦截器+注解的方式。

基本的原理：

url请求时，用拦截器拦截，生成一个唯一的标识符（token），在新建页面中Session保存token随机码，当保存时验证，通过后删除，当再次点击保存时由于服务器端的Session中已经不存在了，所有无法验证通过。

第一步：自定义注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface AvoidDuplicateSubmission {
    boolean needSaveToken() default false;

    boolean needRemoveToken() default false;

    String tokenName() default "token";
}

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：

1.@target

2.@Retention

3.Documented

4.@Inherited

@Target：

作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

取值(ElementType)有：

　　　　1.CONSTRUCTOR:用于描述构造器
　　　　2.FIELD:用于描述域
　　　　3.LOCAL_VARIABLE:用于描述局部变量
　　　　4.METHOD:用于描述方法
　　　　5.PACKAGE:用于描述包
　　　　6.PARAMETER:用于描述参数
　　　　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Retention：

作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

取值（RetentionPoicy）有：

　　　　1.SOURCE:在源文件中有效（即源文件保留）
　　　　2.CLASS:在class文件中有效（即class保留）
　　　　3.RUNTIME:在运行时有效（即运行时保留）

@Inherited：
@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

定义注解格式：
　　public @interface 注解名 {定义体}

Annotation类型里面的参数该怎么设定:
　　第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　　
　　第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　
　　第三,如果只有一个参数成员,最好把参数名称设为”value”,后加小括号.例:下面的例子FruitName注解就只有一个参数成员。
　
　第二步：实现拦截器
　

public class AvoidDuplicateSubmissionInterceptor extends HandlerInterceptorAdapter {

    private static final Logger logger = LogManager.getLogger(AvoidDuplicateSubmissionInterceptor.class);

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        HttpSession session = request.getSession(false);
        Object userId = session == null ? null : session.getAttribute("userId");
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Method method = handlerMethod.getMethod();

        AvoidDuplicateSubmission annotation = method.getAnnotation(AvoidDuplicateSubmission.class);
        if (annotation != null) {
            boolean needSaveSession = annotation.needSaveToken();
            String tokenName = annotation.tokenName();
            if (needSaveSession) {
                request.getSession().setAttribute(tokenName, TokenProccessor.getInstance().makeToken(userId == null ? "" : userId.toString()));
            }

            boolean needRemoveSession = annotation.needRemoveToken();
            if (needRemoveSession) {
                if (isRepeatSubmit(request, tokenName)) {
                    logger.warn("please don't repeat submit,[user:" + userId + ",url:" + request.getServletPath() + "]");
                    ResponseBody responseBody = method.getAnnotation(ResponseBody.class);
                    if (responseBody == null) {
                        response.sendRedirect("repeatsubmit.htm");
                    }
                    return false;
                }
                request.getSession(false).removeAttribute(tokenName);
            }
        }

        return true;
    }

    private boolean isRepeatSubmit(HttpServletRequest request, String tokenName) {
        String serverToken = (String) request.getSession(false).getAttribute(tokenName);
        if (serverToken == null) {
            return true;
        }
        String clientToken = request.getParameter(tokenName);
        if (clientToken == null) {
            return true;
        }
        if (!serverToken.equals(clientToken)) {
            return true;
        }
        return false;
    }

第三步：在springBoot的配置类中加入拦截器

@Configuration
public class StartupConfig extends WebMvcConfigurerAdapter {
    private static final Logger logger = LogManager.getLogger(StartupConfig .class);

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new AvoidDuplicateSubmissionInterceptor()).addPathPatterns("/*.htm");
    }
}

第四步：在相应的controller方法加上注解

@AvoidDuplicateSubmission(needSaveToken = true)
    @RequestMapping(value = "/insertXXX.htm")
    @ResponseBody
    public String insertXXX(Grade grade, HttpServletRequest req, HttpServletResponse resp) {
        JSONObject obj = new JSONObject();
        obj.put("success", true);
        try {

            String message = validateInsertForm(membershipGrade);
            if (StringUtils.isBlank(message)) {
                String userId = req.getSession().getAttribute("userId").toString();
                String userName = req.getSession().getAttribute("realName").toString();
                grade.setId(String.valueOf(SnowFlake.getId()));
                grade.setCreateUser(userId);
                grade.setCreateUserName(userName);
                grade.setCreateTime(DateUtil.formatDatetime(new Date(), "yyyyMMddHHmmss"));
                gradeService.insert(membershipGrade);
                obj.put("message", "添加成功");
            } else {
                obj.put("success", false);
                obj.put("message", message);
            }
        } catch (Exception e) {
            obj.put("success", false);
            obj.put("message", "系统错误");
            logger.error(e.getMessage(), e);
        }
        return obj.toString();
    }

最后在页面的form中加入下面的，就防止重复提交的问题

<input type="hidden" name="token" value="${token}">

下面是生成token的方法

public class TokenProccessor {
    private static final Logger logger = LogManager.getLogger(TokenProccessor.class);

    private TokenProccessor() {
    }

    private static final TokenProccessor instance = new TokenProccessor();

    public static TokenProccessor getInstance() {
        return instance;
    }

    public String makeToken(String userId) {
        String token = (System.currentTimeMillis() + new Random().nextInt(999999999)) + userId;
        try {
            return DigestUtils.md5Hex(token);
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return System.currentTimeMillis() + "";
    }
}

SpringBoot拦截器+注解方式实现防止表单重复提交

猜你喜欢