先描述一下这个功能的场景,在使用微服务时,需要在接口调用时使用json格式加密的形式,在服务提供端接收到消息后,进行消息的解密、转换bean及数据效验。
首先先看请求发送的内容结构
package org.zhao.base.pojo.model;
import java.io.Serializable;
import java.util.List;
import org.zhao.common.annotation.FieldTypeEnum;
import org.zhao.common.annotation.QueryObjectCheck;
/**
* @数表名称 project_view_menu
* @开发日期 2018-08-15
*/
public class ProjectViewMenu implements Serializable{
/**
*
*/
private static final long serialVersionUID = -7668618185512965445L;
/**
*ColomeName id
*Remarks 编号
*JdbcType VARCHAR
*/
private String id;
/**
*ColomeName menu_name
*Remarks 菜单名称
*JdbcType VARCHAR
*/
@QueryObjectCheck(require=true , maxLength = 10 , minLength = 2 ,title="菜单名称")
private String menuName;
/**
*ColomeName parent_menu_id
*Remarks 上级菜单编号
*JdbcType VARCHAR
*/
@QueryObjectCheck(require=true ,title="上级菜单")
private String parentMenuId;
/**
*ColomeName parent_menu_name
*Remarks 上级菜单名称
*JdbcType VARCHAR
*/
private String parentMenuName;
/**
*ColomeName menu_herf
*Remarks 菜单链接
*JdbcType VARCHAR
*/
private String menuHerf;
/**
*ColomeName menu_state
*Remarks 菜单状态1正常2禁用
*JdbcType VARCHAR
*/
private String menuState;
/**
*ColomeName power_key
*Remarks 权限标记
*JdbcType VARCHAR
*/
private String powerKey;
@Override
public String toString() {
return this.id;
}
//GET/SET
}
一个普通的实体对象,不过在其中的属性【menuName】及【parentMenuId】上添加了一个自定义的注解,该注解的作用是在后面做值注入的时候效验。
简单说一下这个注解
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface QueryObjectCheck {
boolean require();//非空
int maxLength() default -1; //字段值最大长度
int minLength() default -1;//字段值最小长度
int max() default -1;//最大值
int min() default -1; //最小值
FieldTypeEnum type() default FieldTypeEnum.STRING ;//字段类型
String title() default "字段";//名称
}
require用于判断值非空 , maxLength和minLength属性用于判断字符串类型的值长度效验
max和min用于判断数值类型的大小
title 用于在返回错误消息时提示错误来源属性
@QueryObjectCheck(require=true , maxLength = 10 , minLength = 2 ,title="菜单名称")
private String menuName;
这里的含义是在对menuName效验时,该属性不能为空 值长度最大为10,最小为2,当未能通过效验时,会提示错误来源为菜单名称字段
接下来就是属性效验的方法
public static <T> ResultContent<T> checkQuery(String json , Class<T> c) {
try {
T t = new Gson().fromJson(json, c);
String msg = checkObject(t);
if(msg == null) return new ResultContent<T>(ResultContent.SUCCESS, "效验通过", t);
log.info("效验失败结论【"+msg+"】");
return new ResultContent<T>(ResultContent.ERROR, msg);
} catch (Exception e) {
e.printStackTrace();
return new ResultContent<T>(ResultContent.ERROR, "转化解析结果失败");
}
}
private static <T> String checkObject(T t) {
try {
Class c = t.getClass();
Field[] fields = c.getDeclaredFields();
for (Field field : fields) {
if(field.isAnnotationPresent(QueryObjectCheck.class)) {
String firstLetter = field.getName().substring(0, 1).toUpperCase();
String getter = "get" + firstLetter + field.getName().substring(1);
Method method = c.getMethod(getter, new Class[] {});
Object value = method.invoke(t, new Object[] {});
QueryObjectCheck qoc = field.getAnnotation(QueryObjectCheck.class);
//获取值 进行效验
if(qoc.type() == FieldTypeEnum.STRING) {
String v = (value == null ? "":value.toString());
if(qoc.require() && StringUtils.isEmpty(v)) return qoc.title() + "不能为空";
if(qoc.minLength() > 0 && v.length() < qoc.minLength()) return qoc.title() + "长度不能小于【"+qoc.minLength()+"】";
if(qoc.maxLength() > 0 && v.length() > qoc.maxLength()) return qoc.title() + "长度不能大于于【"+qoc.maxLength()+"】";
}
else if(qoc.type() == FieldTypeEnum.NUMBER) {
double v = (value == null ? 0:Double.parseDouble(value.toString()));
if(qoc.min() > 0 && v < qoc.min()) return qoc.title() + "值不能小于【"+qoc.min()+"】";
if(qoc.max() > 0 && v < qoc.max()) return qoc.title() + "值不能大于【"+qoc.max()+"】";
}
}
}
} catch (Exception e) {
e.printStackTrace();
return "校验失败";
}
return null;
}
声明了两个函数
实际使用时也可以将两个函数合并,这里为了清晰,分解为两个,
第一个函数checkQuery的作用很简单,依托GSON将请求解密后的json字符串转换为实体bean(加解密功能和本文无关,省略)。
第二个函数checkObject的作用是对转换完成的实体bean做字段的效验,通过获取 字段值上的注解和字段的值,用自己定义的逻辑进行判断,然后返回结果,在返回值为null时表示效验通过,否则,返回结果为错误信息。
ResultContent<ProjectViewMenu> project = QuerySign.checkQuery(
query.getMessage(),//请求解密后的实际json内容
ProjectViewMenu.class//json转换后的实体对象class
);
通过对project对象的code值判断 可知道效验是否通过,如果通过,则直接使用project中的ProjectViewMenu值即可