# leafrest

**Repository Path**: lihuan215/leafrest

## Basic Information

- **Project Name**: leafrest
- **Description**: 简化写接口时的参数验证，理论上支持验证所有request parameter类型的参数，目前的example是基于SpringMVC写的
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-07-24
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#leafrest是一个为简化写接口api验证而诞生的组件

 **使用方法：** 


1.引入leafrest-core-0.0.1.RELEASE.jar包

2.Spring配置文件增加扫描
```
<context:component-scan base-package="com.leafrest.core*" />
```

3.增加Spring bean和Spring aop配置 

```
<bean id="paramValidate" class="com.leafrest.core.aspect.ParamValidateAspect"/>
<aop:config>
	<aop:aspect id="paramValidate" ref="paramValidate">
		<!--注意，这里要配置你自己的Controller位置-->
		<aop:pointcut id="target" expression="execution(* com.zzstep.controller.*.*Controller.*(..))" />
		<aop:around method="validate" pointcut-ref="target" />
	</aop:aspect>
</aop:config>
```


好了，去享受便捷的参数验证吧，这时候你再写接口时，只需要在需要验证的method增加一行注解，如：

```
@ParamValidater(parameters = { 
	@Param(name = "id", type = type.LONG, require = true),
	@Param(name = "mobile", type = type.MOBILE, minLength = 11) 
})
public Map<String, Object> test(HttpServletRequest request) {...}
```

这样ParamValidater就会自动去验证id是否是长整型且不为空，mobile是否是合法的手机号码且大于等于11位了

 **ParamValidater也是支持自定义错误和正则表达式的** 
下面是一个简单的例子：
```
@ParamValidater(parameters = { 
	@Param(name = "password", require = true, regex="^[_0-9a-zA-Z]{6,}$", error=@CustomError(code=3000, msg="密码格式不正确!")) 
})
public Map<String, Object> testRegex(HttpServletRequest request) {...}
```

好了，更多功能就需要你自己去发掘了，有好的想法可以留言告诉我!