JFinal 参数校验插件扩展,让后台参数校验像js一样方式好用

一、插件实现

插件的功能就是加载校验规则,实现代码如下

package com.nmtx.plugins.validation;

import java.util.Properties;

import com.jfinal.core.Const;
import com.jfinal.kit.Prop;
import com.jfinal.kit.PropKit;
import com.jfinal.plugin.IPlugin;

public class ValidationPlugin implements IPlugin{
	protected Prop prop = null;

    public ValidationPlugin(String fileName) {
        prop = PropKit.use(fileName, Const.DEFAULT_ENCODING);
    }

    public ValidationPlugin(String fileName, String encoding) {
        prop = PropKit.use(fileName, encoding);
    }
    /**
     * 初始化校验规则
     */
	public boolean start() {
		Properties properties = prop.getProperties();
		for (Object object : properties.keySet()) {
			String key = (String) object;
			String rule[] = properties.getProperty(key).split(",");
			ValidationRules.ruleMap.put(key, rule[0]);
			ValidationRules.ruleErrorMessageMap.put(key,rule[1]);
		}
		return true;
	}

	public boolean stop() {
		return true;
	}
}
package com.nmtx.plugins.validation;

import java.util.HashMap;
import java.util.Map;
import java.util.regex.Pattern;

import com.jfinal.kit.StrKit;

public class ValidationRules {
	static Map<String, String> ruleMap = new HashMap<String,String>();
	static Map<String, String> ruleErrorMessageMap = new HashMap<String,String>();

	public static boolean isMatch(String rule, String value) {
		boolean matchResult;
		if(rule.equals("required")){
			matchResult = StrKit.notBlank(value);
		}else {
			if(StrKit.notBlank(value))matchResult = Pattern.compile(ruleMap.get(rule)).matcher(value).matches();
			else matchResult = true;
		}
		return matchResult;
	}
	
	public static String getErrorMessage(String rule){
		return ruleErrorMessageMap.get(rule);
	}
}

规则加载后就是如何拦截校验了,这里用拦截器实现大概如下

package com.nmtx.plugins.validation;

import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

import com.jfinal.aop.Duang;
import com.jfinal.aop.Interceptor;
import com.jfinal.aop.Invocation;
import com.jfinal.core.Controller;
import com.jfinal.kit.StrKit;
import com.nmtx.common.ErrorCode;
import com.nmtx.common.MessageResp;
import com.nmtx.controller.para.IParaFormat;
import com.nmtx.controller.para.impl.HumpToMiddleScoreFormat;

public class ValidatorInterceptor implements Interceptor {
    private IParaFormat humpParaFormat = Duang.duang("humpParaFormat", HumpToMiddleScoreFormat.class);
	public void intercept(Invocation inv) {
		String methodName = inv.getMethodName();
		Controller controller = inv.getController();
		Method[] methods = controller.getClass().getDeclaredMethods();
		boolean matchResult = true;
		for (Method method : methods) {
			if (method.getName().equals(methodName)) {
				boolean hasAnnotation = method.isAnnotationPresent(Validation.class);
				if (hasAnnotation) {
					Validation anno = method.getAnnotation(Validation.class);
					Map<String, String> ruleMap = dealRule(anno.rules());
					for (String key : ruleMap.keySet()) {
						String value = controller.getPara(humpParaFormat.paraToFormat(key));
						String rule = ruleMap.get(key);
						matchResult = ValidationRules.isMatch(rule, value);
						MessageResp<String> message = new MessageResp<String>();
						message.setCode(ErrorCode.ERROR);
						if (!matchResult) {
							message.setMessage(humpParaFormat.paraToFormat(key)+ValidationRules.getErrorMessage(rule));
							message.setData("");
							controller.renderJson(message);
							break;
					   }
					}
				}
			}
		}
		if (matchResult)
			inv.invoke();
	}

	public Map<String, String> dealRule(String rules) {
		Map<String, String> map = new IdentityHashMap<String, String>();
		if (StrKit.notBlank(rules)) {
			String[] paraRules = rules.split(";");
			for (String paraRule : paraRules) {
				String[] para = paraRule.split("=");
				map.put(para[0], para[1]);
			}
		}
		return map;
	}

}

有了拦截器,拦截的方法肯定需要注解了,注解实现如下

package com.nmtx.plugins.validation;

import java.lang.annotation.*;

/**
 * 定义Validator规则的注解
 * @author lianghao
 *
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Validation {
	String rules ();
}

这样拦截插件构造就完成了

二,使用篇

添加插件

	/**
	 * 定义插件,如数据库连接等一些插件
	 */
	@Override
	public void configPlugin(Plugins me) {
	 
		me.add(new ValidationPlugin("validation.properties"));
		 
	 
	}

添加全局拦截

/**
	 * 必须按这种顺序,不允许改,不得在新增新的全局拦截器
	 */
	@Override
	public void configInterceptor(Interceptors me) {
		me.add(new ValidatorInterceptor());
	}

只需一个注解就搞定参数校验,demo如下

	@Validation(rules = "userName=required;password=required")
	public void login() {
		
	}

需要什么规则还可以自己加在配置文件里,附上一些常用的校验

email=^\\w+([-+.]\\w+)*@\\w+([-.]\\w+)*\\.\\w+([-.]\\w+)*$,"邮箱格式不正确" chinese=^[\u4e00-\u9fa5]+$,"不是中文"  number=^[0-9]*$,"只能输入数字" phone=^1+[0-9]{10}$,"号码格式不正确" idcard=^(\\d{15}|\\d{18})$,"身份证号码不正确"//15或18位 postCode=^[0-9]{6}$,"邮政编码格式不正确" url=[a-zA-z]+://[^\s]*,"url格式不对" date=[0-9]{4}-[0-9]{2}-[0-9]{2},"时间格式不对(yyyy-mm-dd)" creditcard=^((?:4\d{3})|(?:5[1-5]\d{2})|(?:6011)|(?:3[68]\d{2})|(?:30[012345]\d),"信用卡格式不正确" acceptImg=[.](jpg|gif|bmp|png)$,"图片后缀名格式不正确" acceptFile=[.](xls|xlsx|csv|txt)$,"文件后缀名格式不正确" required=required,"参数不能为空"

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏码洞

大厨小鲜——基于Netty自己动手编写RPC框架

今天我们要来做一道小菜,这道菜就是RPC通讯框架。它使用netty作为原料,fastjson序列化工具作为调料,来实现一个极简的多线程RPC服务框架。

1952
来自专栏ImportSource

Junit 5新特性全集

本文略长,但都是大白话,如果你能一口气看完,你赢了。 如果你来不及看这么长,那么建议你滑到文末,直接看黑体部分就知道大概了。 在5中的一个测试类的基本生命周期是...

47012
来自专栏后端沉思录

SPI概念及使用方法

SPI全称Service Provider Interfaces,用于发现接口的实现。在jdbc、日志、dubbo的设计中都使用SPI用于服务的发现。简单的以j...

1892
来自专栏小灰灰

EventBus源码学习笔记(二)

EventBus深入学习二 开始研究源码的设计思路,从Listener注册出发,EventBus 如何维护监听者信息,到Publisher发送消息,消息以怎样...

2565
来自专栏冰霜之地

高效的序列化/反序列化数据方式 Protobuf

上篇文章中其实已经讲过了 encode 的过程,这篇文章以 golang 为例,从代码实现的层面讲讲序列化和反序列化的过程。

4815
来自专栏wannshan(javaer,RPC)

dubbo 缓存的使用和实现解析

dubbo缓存主要实现,对方法调用结果的缓存。 在服务消费方和提供方都可以配置使用缓存。 以消费方为例,可以配置全局缓存策略,这样所有服务引用都启动缓存 ...

3436
来自专栏Java成神之路

Java微信开发_Exception_01_The type org.xmlpull.v1.XmlPullParser cannot be resolved. It is indirectly ref

这个异常是在做微信开发时出现的,在引入了XStream的jar包之后,还是出现了如下错误信息:

893
来自专栏三好码农的三亩自留地

Java动态代理-实战

说动态代理之前,要先搞明白什么是代理,代理的字面意思已经很容易理解了,我们这里撇开其他的解释,我们只谈设计模式中的代理模式

2402
来自专栏分布式系统进阶

Kafka中Message存储相关类大揭密Kafka源码分析-汇总

1681
来自专栏美码师

补习系列-springboot 参数校验详解

在定义 Restful 风格的接口时,通常会采用 PathVariable 指定关键业务参数,如下:

5531

扫码关注云+社区