利用MyBatis插件实现统一的用户输入长度校验

最新推荐文章于 2024-09-02 11:08:17 发布
最新推荐文章于 2024-09-02 11:08:17 发布
阅读量3.6k 收藏 5
点赞数 2
分类专栏： 开发思路 文章标签： mybatis 全局长度检验
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/shikezhan/article/details/83242535
版权

本文描述了如何统一的增加用户输入长度校验以及自己的思考过程

1、需求

在理想情况下，无论是前端还是后台都应该对用户输入的长度做检验。在每个页面和后台的接口都加上检验，比较繁琐，而且编码人员经常忽视检验。造成用户输入的长度大于数据库设定的长度就会直接报错。因此希望在框架上做统一校验。

2、分析

系统采用的是spring+spring mvc+mybatis+mysql。

分析前，先整理下新增或修改请求的大致流程：

1.客户端提交数据，如：/rest/user/add?name=张三&age=18。如果字段比较多通常用json格式post，格式：{name:"张三",age:18}

2.无论何种形式提交过来，后台先由spring的拦截器拦截，主要做登录验证，确保请求身份的合法性。

3.如果是合法请求，会根据请求地址跳到对应的controller里面。

4.controller调用对应的业务类。在该类里，会根据name,age等参数，创建一个user类型的po对象。

在我们的项目里，数据库里的每一张表都会有一个po实体对象与之对应，这些对象都由mybatis generator 统一生成。与po对象同时生成的还有mapper和sql配置文件。

5.调用mapper的insert 方法，代码类似于：

User u = new User();
u.setName(user);
u.setAge(age);
u.setUserId(GUID);
userMapper.insert(user);//保存到数据库

6.在执行sql之前会先经过mybatis的插件/拦截器

7.最后调用mybatis里的 Executor对象的update方法，执行sql语句。

大致这7步，一些细致末节已略去。接下来便是分析思路（嫌烦的朋友可以直接看第三部分的实现）：

首先既然是统一的校验，肯定是放在公共的地方，每个接口都会调用。最合适的地方便是第2或6步骤，通过拦截器统一处理。2和6里面，2其实是最合适的，因为如果检验不通过，直接返回给客户端，效率最高。

检验前需要获取用户输入的长度和数据库里设定的长度。获取这两个长度应该都没问题。但步骤2却有个问题，提交过来的参数各式各样，将参数和数据库字段对应起来有难度。因此先放弃该方案。

再来分析步骤6。在项目里所有的更新或新增方法数据都是用po对象传递过去（个别直接写sql语句的除外），如：userMapper.insert(user)；这里的参数user就是一个po对象。而po对象有个好处就是它里面的字段都可以和数据库的字段对应起来。

找到这个突破口似乎看到了一丝曙光。在执行sql之前的拦截方法里面我们应该可以拿到po对象。进而我们就得到了用户的输入长度。如果用户输入有多项，我们只要通过反射遍历po对象的每个属性就可以了。

到这里我们还缺数据库字段的长度。因为上面提到需要反射遍历po对象的所有属性，所以第一个想法就是把长度用注解的方式加在字段上，这样就可以直接比较了，如：

public class User implements Serializable {
    /**
     * 用户登录名
     *
     * @mbggenerated
     */
    private String username;

    /**
     * 登录手机号
     *
     * @mbggenerated
     */
    private String phone;

     /**
     * 获取 用户登录名
     *
     * @return 用户登录名
     *
     * @mbggenerated
     */
    @org.beanopen.fw.ws.annotation.CodeFieldNotes("用户登录名")
    @org.beanopen.tools.mybatis.annotation.DBColumnLength(45)
    public String getUsername() {
        return username;
    }

    /**
     * 获取 登录手机号
     *
     * @return 登录手机号
     *
     * @mbggenerated
     */
    @org.beanopen.fw.ws.annotation.CodeFieldNotes("登录手机号")
    @org.beanopen.tools.mybatis.annotation.DBColumnLength(11)
    public String getPhone() {
        return phone;
    }
}

这里每个字段都有两个注解，字段名称和长度。

到这一步感觉胜利在望了。但每个字段的注解都手工配置，那也不可行。好在上文已经提到，po对象都是mybatis generator里生成，mybatis generator也提供了插件机制，允许生成时，添加用户自己的逻辑。那么生成实体对象时添加字段程度的注解即可。

以上思路总结为：

1.mybatis generator 生成实体对象时，为每个字符串属性添加关于字段长度的自定义注解。

2.mybatis 执行sql方法之前进行拦截，遍历po对象的每个字符串属性，比较用户输入长度和注解长度。

3.如果过长，则抛出异常。后台进行统一的异常处理返回友好的错误提示。

3.代码实现

首先是mybatis generator的插件部分：



package org.beanopen.tools.mybatis.generator;

import java.util.List;

import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.Plugin;
import org.mybatis.generator.api.PluginAdapter;
import org.mybatis.generator.api.dom.java.Method;
import org.mybatis.generator.api.dom.java.TopLevelClass;

public class DBColumnLengthPlugin extends PluginAdapter {

    public DBColumnLengthPlugin() {
    }

    public boolean modelGetterMethodGenerated(Method method, TopLevelClass topLevelClass,
                                              final IntrospectedColumn introspectedColumn, IntrospectedTable introspectedTable,
                                              Plugin.ModelClassType modelClassType) {

        List<IntrospectedColumn> pkcs = introspectedTable.getPrimaryKeyColumns();

        if("VARCHAR".equals(introspectedColumn.getJdbcTypeName())
                &&pkcs.indexOf(introspectedColumn)<0){
            //数据库字段为varchar类型的,且不是主键的属性上添加注解
            method.addAnnotation("@org.beanopen.tools.mybatis.annotation.DBColumnLength("
                    +introspectedColumn.getLength()
                    + ")");
        }

        return true;
    }

    /**
     * This plugin is always valid - no properties are required
     */
    @Override
    public boolean validate(List<String> warnings) {
        return true;
    }
}

自定义的插件类继承于org.mybatis.generator.api.PluginAdapter，主要在modelGetterMethodGenerated方法里，getter方法上添加字段长度的注解

插件写好之后，还需要配置进去。在mybatis generator的配置文件generatorConfig.xml里添加插件<plugin type="org.beanopen.tools.mybatis.generator.DBColumnLengthPlugin" />：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
		"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >
<generatorConfiguration>
	<classPathEntry location="conf/lib/mysql-connector-java-5.1.15.jar" />
	<context id="context1">
		
		<property name="javaFileEncoding" value="UTF-8"/>
		
		<plugin type="org.beanopen.tools.mybatis.generator.MySQLPaginationPlugin2" />
        <!-- 添加刚才写好的插件 -->
		<plugin type="org.beanopen.tools.mybatis.generator.DBColumnLengthPlugin" />
		<plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
		
		………………



	</context>

</generatorConfiguration>

到这里生成实体的时候就会自动添加注解了。接下来便是mybatis的拦截代码：

package org.beanopen.tools.mybatis;

import org.apache.commons.lang3.StringUtils;
import org.apache.ibatis.executor.Executor;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.plugin.*;
import org.beanopen.fw.ws.annotation.CodeFieldNotes;
import org.beanopen.tools.mybatis.annotation.DBColumnLength;

import java.beans.PropertyDescriptor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Properties;

@Intercepts(@Signature(type = Executor.class, method = "update", args = {
        MappedStatement.class, Object.class}))
public class DBColumnLengthCheck implements Interceptor {
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object arg = invocation.getArgs()[1];
        Field[] fields = arg.getClass().getDeclaredFields();
        for (int i = 0; i < fields.length; i++) {//遍历每个属性
            Field field = fields[i];

            if(field.getType() == String.class) {
                PropertyDescriptor pd = new PropertyDescriptor(field.getName(), arg.getClass());
                Method getMethod = pd.getReadMethod();
                if (getMethod != null) {
                    DBColumnLength length = getMethod.getAnnotation(DBColumnLength.class);

                    if(length!=null) {//如果有DBColumnLength注解,则需要判断
                        Object value = getMethod.invoke(arg);
                        if(value!=null){
                            if(length.value()<value.toString().length()){//输入内容过长时抛出异常
                                CodeFieldNotes fieldNotes = getMethod.getAnnotation(CodeFieldNotes.class);//CodeFieldNotes 注解是字段名称,为了显示友好而已,这里可忽略
                                String fieldName = fieldNotes!=null&& StringUtils.isNotBlank(fieldNotes.value())?fieldNotes.value():field.getName();
                                throw new RuntimeException(String.format("\"%s\"输入项不能多于%s个字符，您已输入%s个",fieldName,length.value(),value.toString().length()));
                            }
                        }
                    }
                }
            }
        }

        return invocation.proceed();
    }

    @Override
    public Object plugin(Object o) {
        return Plugin.wrap(o, this);
    }

    @Override
    public void setProperties(Properties properties) {

    }

}

这里类注解@Intercepts @Signature指定了要拦截Executor类的update方法。mybatis貌似有4个类可以拦截，Executor类是其中一个

我们重写了intercept方法，添加了一段检验代码，如果检验通过则调用invocation.proceed()，继续原有逻辑；反之抛出异常。

将插件配置进去<bean class="org.beanopen.tools.mybatis.DBColumnLengthCheck"> </bean>：

<!-- 数据库会话工厂 -->
	<bean name="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
		<property name="configLocation" value="classpath:config/mybatis-configuration.xml"></property>
		<property name="dataSource" ref="dataSource" />
		<property name="mapperLocations" value="classpath*:cn/bodtec/zzb/mappers/**/*.xml" />
		<property name="plugins">
			<list>
				<bean
					class="org.beanopen.tools.mybatis.pagination.PaginationInterceptor">
					<property name="dialect">
						<bean class="org.beanopen.tools.mybatis.pagination.dialect.MySQLDialect" />
					</property>
				</bean>
                <!-- 添加插件 -->
				<bean class="org.beanopen.tools.mybatis.DBColumnLengthCheck"> </bean>
			</list>
		</property>
	</bean>

主要代码算是完成了，为了让程序更友好，可以再对异常做全局处理。代码就不放了。

4.总结

此方案比较简单，日常开发中，只需建表的时候将字段名称和长度定好就可以了，其他什么都不用做。后台将会自动进行校验。缺点是性能稍差，在执行sql前才做校验。期待能有更好的方案。

 

 

 

 

 

 

 

shikezhan
关注
专栏目录
MyBatis-Plus自定义字符串长度格式化策略详解
奇妙的Bug之旅
01-09 654
MyBatis-Plus作为一个强大的ORM框架，提供了灵活的字符串长度格式化策略，可以方便地实现这一需求。然而，在某些情况下，我们可能需要根据实际需求自定义字符串长度的格式化策略。例如，当数据库中存在包含空格的字符串时，默认的格式化策略可能会返回错误的结果。在这两个方法中，我们可以使用正则表达式或其他方式来获取字符串的实际长度，并将其赋值给相应的字段。在MyBatis-Plus的配置类中，我们需要注册自定义的字符串长度格式化策略。首先，我们需要创建一个自定义的字符串长度格式化策略类，该类需要实现。
mybabits 写参数的长度_这么写参数校验(Validator)就不会被劝退了~
weixin_31282705的博客
12-30 390
为什么要用validator实战演练1. @Validated 声明要检查的参数2. 对参数的字段进行注解标注3. 在全局校验中增加校验异常4. 测试自定义参数注解1. 比如我们来个 自定义身份证校验 注解2. 然后自定义Validator3. 使用自定义的注解4.使用groups的校验5.restful风格用法总结《Java 2019 超神之路》《Dubbo 实现原理与源码解析 —— 精品合集》...
Mybatis 的if判断里面的 test使用length()判断字符串长度
m0_67401499的博客
03-22 1503
Mybatis 的if判断里面的 test使用length()判断字符串长度 在Mybatis里面需要根据字符串的长度判断取不同的字段或者获取字段的长度。 <choose> <when test="categoryIds != null and categoryIds != '' and categoryIds.length() == 3"> AND SUBSTR(moi.category_id, 1, 3) = #{categoryIds} <
MyBatis中＜if＞校验参数注意问题
最新发布
qq312798536的博客
09-02 175
非空判断“map.sendState!= '‘”，将Integer类型参数与空字符串‘’比较，导致校验错误，实际执行的SQL中跳过<if>标签内的条件。MyBatis中进行非空校验时，除null判断以外，需要结合与前端的约定判断是否需要多余的校验，防止因参数类型导致的校验失败。前端传参"sendState": 0，后端接收到参数类型为：Integer。入参格式Map<String,Object>
mybatis-plus整合@Valid参数校验
写bug的小哥哥
09-03 6839
1.使用MyBatisCodeHelperPro生成实体类 使用插件来生成实体类已经mapper以节省时间 https://blog.csdn.net/weixin_39025362/article/details/108214020 2.@Valid 注解类型的使用 注解 作用 @NotNull 参数不能为null @NotBlank 参数值不不为null，且去除首尾空格后长度不为0，多于用字符串 @NotEmpty 参数不为null且不为空，字符串长度不为0、集合大小不为0
Mybatis 字符串校验
weixin_34124939的博客
06-20 1047
*Mybatis 踩过的坑之字符串校验 一直在被这个坑坑害着，很是郁闷，每次传入字符串‘0’都不被拦截，导致生产上数据出现问题，今天得空来记录一下： 未修改前： <if test="companyId != null and companyId != '0'"> and cc.company_id = #{companyId} </if> 复制代码通过查阅资料得知...
Mybatis插件之通用Mapper&PageHelper
MOKE_SPACE
02-20 728
文章目录通用Mapper使用方法：实体类注解通用方法详解分页插件简单使用PageInfo 通用Mapper 通用 Mapper 是基于 MyBatis 的一个插件，它实现了大部分常用的增删改查方法 只需要继承它就能拥有它所有的通用方法，可以有效减少对XML中SQL语句的编写 然而对于复杂的查询语句还是需要手写 XML 使用方法： 1.maven依赖（引入jar包） &amp;amp;lt;!-- 通用Ma...
MyBatis Eclipse插件安装
hapier的博客
04-23 964
MyBatis Eclipse插件安装 1在线安装generator插件 2离线安装generator插件   3generator调用 MyBatis Generator中文文档 MyBatis Generator中文文档 运行MyBatis Generator XML配置详解
Idea插件开发-JPA、MyBatis实体类代码生成器插件
icarusliu的专栏
07-16 5692
使用Spring开发项目的过程中，习惯于使用JPA进行表的创建、数据的更新等操作，但JPA对于复杂查询的支持比较差，因此很多时候又会同时引入mybatis来进行复杂查询。 再加上实体对象与传输对象分离，在开发一个简单的表单查询维护功能时，也需要创建很多的类来完成对应功能的开发，如DTO对象、数据库操作类、DTO与实体类转换器、操作服务接口、操作服务接口实现类、控制器等。每次我们新创建一个实体类，都...
扩展mybatis重写mybatis执行器实现灵活批处理
夕阳的博客
08-27 2193
     在用mybatis作为持久层框架时，有时候会有需要进行批量增删改的操作。 百度了一下，大致有两种方法，一种是拼接SQL的方式。类似这样： &lt;insert id="insertList" parameterType="java.util.List" &gt; insert into t_project ( projectid,productid ) values ...
SSM整合(MyBatis-Spring-SpringMVC)...校验技术
qq_45181415的博客
03-16 747
实用技术-校验框架 SSM整合-视频 纯注解开发SSM 1 校验框架 1.1 入门 1.1.1 表单校验的重要性 表单校验保障了数据有效性、安全性 数据可以随意输入，导致错误的结果。 1.1.2 表单校验分类 按校验位置分类： 客户端校验：浏览器，手机APP 服务端校验：后端服务器代码校验 按校验内容分类： 格式校验：比如年龄是否为负数，邮箱是否符合规则 逻辑校验：比如用户名在当前项目中是否已注册（需要查询数据库或者业务校验） 1.1.3 格式校验规则 以下几种全部属于格式校验： 长度.
java-mybatis注解-入参校验
weixin_45149147的博客
11-15 1326
mybatis-plus注解 @TableId 描述：主键注解 属性 类型 必须指定 默认值 描述 value String 否 “” 主键字段名 type Enum 否 IdType.NONE 主键类型 IdType 值 描述 AUTO 数据库自增 INPUT 自行输入 ID_WORKER 分布式全局唯一ID 长整型类型 UUID 32位UUID字符串 NONE 无状态 ID_WORKER_STR 分布式全局唯一ID 字符串类型 @Ta
MyBatis Plus代码生成器
qq_31493411的博客
03-26 161
AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。 在pom中添加： <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="...
mybatis拦截器实现update之前根据pk字段校验数据有效性
marke_huang的博客
10-31 1111
/** * 数据有效性检查拦截器 .&amp;amp;amp;lt;br&amp;amp;amp;gt; * * @author marke.sher * @date 2018/10/29 11:15 */ @Intercepts({@Signature( type = Executor.class, method = &amp;amp;quot;update&amp;amp;quot;, args
MyBatis标签获取数组或者集合长度的方法
weixin_48811255的博客
02-27 1753
MyBatis标签获取数组或者集合长度的方法
mybatis-plus通用参数统一处理
m0_37298602的博客
10-20 1707
背景：实际开发中，我们经常会为表设计创建人、创建时间、更信人、更新时间等通用字段，每个接口都需要增加or修改这些字段，1是代码冗余，2则容易出错。mybatis-plus提供了一种统一处理的方案，解决了这一痛点。 如果需要理解mybatis-plus的基础用法，可以查看作者的另外两篇文章 Mybatis-Plus的使用_m0_37298602的博客-CSDN博客https://blog.csdn.net/m0_37298602/article/details/117788047Mybatis-plus分
（快速入门）MyBatis Generator源码分析修改和自定义插件
Cocos的博客
05-09 9035
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值