【SpringBoot校验框架】你还在Java代码里面写中文Validation Msg？

最新推荐文章于 2024-01-04 17:16:57 发布
最新推荐文章于 2024-01-04 17:16:57 发布
阅读量386 收藏
点赞数
文章标签： java restful spring boot json opera
原文链接：http://mp.weixin.qq.com/s?__biz=MzU2OTcxMDc2Mw==&mid=2247487209&idx=1&sn=6b309084ff0468578d2862333c98637f&chksm=fcfbcf2dcb8c463b619b76005403bd8dc9d26b06f65abca91e1a2ebf611d4519c91641a02c3b
版权

一、概述

虽然前端系统对后台 API 接口调用之前都会做数据的校验，但是考虑到很多 API 接口是直接暴露在外网中，后台接口对传入的参数做校验是不可缺少的。比如判断字段非空，字段长度限制，邮箱格式验证等，这时就可以用到 Validation。

二、创建 Spring Boot 工程

a6990780a201697d119557c3b7dd3afe.png acd9c1c0db9ae7c5e8fe7e516582b42f.png 764ed5b4082f261e32af0e8b6802392c.png

三、创建类

3.1  UserVo 类

package com.anron.vo;
 
import lombok.Data;
import javax.validation.constraints.*;
import java.io.Serializable;
import java.util.List;
 
/**
 * @Author: Anron
 * @Date: 2020/3/29 17:30
 */
@Data
public class UserVo implements Serializable {
    private static final long serialVersionUID = 3869883763128105939L;
 
    @NotEmpty(message="{vo.UserVo.NAME_NOT_EMPTY}")
    private String name;
 
    @Min(value=18, message="{vo.UserVo.AGE_MUST_GREATERTHAN_18}")
    private int age;
 
    @NotEmpty(message="{vo.UserVo.HOBILLES_NOT_EMPTY}")
    private List<String> hobbies;
 
    @NotBlank(message="{vo.UserVo.ACCOUNT_NOT_EMPTY}")
    private String account;
 
    @NotNull(message="{vo.UserVo.PLATENO_NOT_EMPTY}")
    private String plateNo;
 
    @NotBlank(message="{vo.UserVo.ADDRESS_NOT_EMPTY}")
    private String address;
 
    @Size(min=6, max=20, message="{vo.UserVo.PASSWORD_SIZE}")
    @NotBlank(message="{vo.UserVo.PASSWORD_NOT_EMPTY}")
    private String password;
 
    @Email(message="{vo.UserVo.EMAIL_ERROR_FORMAT}")
    @NotBlank(message="{vo.UserVo.EMAIL_NOT_EMPTY}")
    private String email;
}

3.2  AppController 类

package com.anron.controller;
 
import com.anron.dto.BaseDto;
import com.anron.util.WebControllerUtil;
import com.anron.vo.UserVo;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
 
/**
 * @Author: Anron
 * @Date: 2020/3/29 17:32
 */
@Slf4j
@Controller
@RequestMapping(value = "/app")
public class AppController {
 
    @RequestMapping(value = "/addUser.do")
    @ResponseBody
    public BaseDto addUser(@RequestBody @Validated UserVo vo, BindingResult bindingResult, HttpServletRequest request) {
        log.info("---addUser start---vo:{}", vo.toString());
        WebControllerUtil.buildErrorMsg(bindingResult, request);
        return new BaseDto(true);
    }
}

3.3  BaseDto 类

package com.anron.dto;
 
import lombok.Data;
import java.io.Serializable;
 
/**
 * @Author: Anron
 * @Date: 2020/3/29 17:34
 */
@Data
public class BaseDto implements Serializable {
    private static final long serialVersionUID = -1423147470994861814L;
 
    private String code;
    private String message;
 
    public BaseDto(boolean success) {
        if (success) {
            this.code = "0";
            this.message = "OK";
        }else {
            this.code = "500";
            this.message = "";
        }
    }
}

3.4  WebControllerUtil 类

package com.anron.util;
 
import com.anron.exception.ServiceException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import javax.servlet.http.HttpServletRequest;
 
/**
 * @Author: Anron
 * @Date: 2020/3/29 17:37
 */
public class WebControllerUtil {
 
    public static void buildErrorMsg(BindingResult bindingResult, HttpServletRequest request) {
        if (bindingResult.hasErrors()) {
            String errorMsg = "";
            for (ObjectError error : bindingResult.getAllErrors()) {
                errorMsg += error.getDefaultMessage() + ",";
            }
            throw new ServiceException(errorMsg.substring(0, errorMsg.length() - 1));
        }
    }
}

3.5  ServiceException 类

package com.anron.exception;
 
import lombok.Data;
 
/**
 * @Author: Anron
 * @Date: 2020/3/29 17:38
 */
@Data
public class ServiceException extends RuntimeException {
    private static final long serialVersionUID = 5412240839931206939L;
 
    private int code;
    private String msg;
 
    public ServiceException(String msg){
        super();
        this.code = 501;
        this.msg = msg;
    }
}

3.6  ControllerExceptionHandler 类

package com.anron.exception;
 
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.nio.charset.StandardCharsets;
 
/**
 * @Author: Anron
 * @Date: 2020/3/29 17:46
 */
@ControllerAdvice
public class ControllerExceptionHandler {
    private static final int RESPONSE_STATUS = 200;
 
    @ExceptionHandler(ServiceException.class)
    public String handleException(HttpServletRequest request, HttpServletResponse response, ServiceException e) throws Exception {
        response.getOutputStream().write(e.toString().getBytes(StandardCharsets.UTF_8));
        response.setCharacterEncoding("UTF-8");
        response.setContentType("application/json");
        response.setStatus(RESPONSE_STATUS);
        response.getOutputStream().flush();
        return null;
    }
}

四、创建资源文件

4.1 ValidationMessages.properties

vo.UserVo.NAME_NOT_EMPTY=姓名不能为空
vo.UserVo.AGE_NOT_EMPTY=年龄不能为空
vo.UserVo.AGE_MUST_GREATERTHAN_18=年龄必须大于等于18岁
vo.UserVo.HOBILLES_NOT_EMPTY=兴趣爱好不能为空
vo.UserVo.ACCOUNT_NOT_EMPTY=账号不能为空
vo.UserVo.PLATENO_NOT_EMPTY=车牌号码不能为空
vo.UserVo.ADDRESS_NOT_EMPTY=地址不能为空
vo.UserVo.PASSWORD_SIZE=密码的长度应该在6和20之间
vo.UserVo.PASSWORD_NOT_EMPTY=密码不能为空
vo.UserVo.EMAIL_ERROR_FORMAT=邮箱格式错误
vo.UserVo.EMAIL_NOT_EMPTY=邮箱不能为空

4.2 ValidationMessages_zh_TW.properties

vo.UserVo.NAME_NOT_EMPTY=姓名不能為空
vo.UserVo.AGE_NOT_EMPTY=年齡不能為空
vo.UserVo.AGE_MUST_GREATERTHAN_18=年齡必須大於等於18嵗
vo.UserVo.HOBILLES_NOT_EMPTY=興趣愛好不能爲空
vo.UserVo.ACCOUNT_NOT_EMPTY=賬號不能爲空
vo.UserVo.PLATENO_NOT_EMPTY=車牌號碼不能爲空
vo.UserVo.ADDRESS_NOT_EMPTY=地址不能爲空
vo.UserVo.PASSWORD_SIZE=密碼的長度應該在6和20之間
vo.UserVo.PASSWORD_NOT_EMPTY=密碼不能爲空
vo.UserVo.EMAIL_ERROR_FORMAT=郵箱格式錯誤
vo.UserVo.EMAIL_NOT_EMPTY=郵箱不能爲空

4.3 ValidationMessages_en.properties

vo.UserVo.NAME_NOT_EMPTY=The name cannot be empty
vo.UserVo.AGE_NOT_EMPTY=The age cannot be empty
vo.UserVo.AGE_MUST_GREATERTHAN_18=Must be at least 18 years old
vo.UserVo.HOBILLES_NOT_EMPTY=A hobby cannot be empty
vo.UserVo.ACCOUNT_NOT_EMPTY=The account cannot be empty
vo.UserVo.PLATENO_NOT_EMPTY=The license plate number cannot be blank
vo.UserVo.ADDRESS_NOT_EMPTY=The address cannot be empty
vo.UserVo.PASSWORD_SIZE=The length of the password should be between 6 and 20
vo.UserVo.PASSWORD_NOT_EMPTY=The password cannot be empty
vo.UserVo.EMAIL_ERROR_FORMAT=Mailbox format error
vo.UserVo.EMAIL_NOT_EMPTY=The mailbox cannot be empty

五、创建 http 测试文件

5.1 AppController.addUser.http

POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
Accept-Language: zh-CN;q=0.9,zh;q=0.8
 
{
 
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
Accept-Language: en,zh-CN;q=0.9,zh;q=0.8
 
{
"age":17
}
 
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
Accept-Language: zh-CN;q=0.9,zh;q=0.8
 
{
"age":18
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
Accept-Language: zh-TW;q=0.9,zh;q=0.8
 
{
"age":18,
"hobbies": []
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"]
}
 
 
###@NotEmpty(message="姓名不能为空")，所以"name": " "也通过
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": " "
}
 
###@NotBlank(message="账号不能为空")，所以"account": " "不通过
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": "anron",
"account": " "
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": "anron",
"account": "admin"
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": "anron",
"account": "admin",
"address": "shenzhen, china"
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": "anron",
"account": "admin",
"address": "shenzhen, china",
"plateNo": ""
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": "anron",
"account": "admin",
"address": "shenzhen, china",
"plateNo": "",
"password": "12"
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": "anron",
"account": "admin",
"address": "shenzhen, china",
"plateNo": "",
"password": "123456"
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": "anron",
"account": "admin",
"address": "shenzhen, china",
"plateNo": "",
"password": "123456",
"email": "error email address"
}
 
###
POST http://localhost:8080/app/addUser.do
Accept: */*
Cache-Control: no-cache
Content-Type: application/json
 
{
"age":18,
"hobbies": ["sport", "food"],
"name": "anron",
"account": "admin",
"address": "shenzhen, china",
"plateNo": "",
"password": "123456",
"email": "anron@gmail.com"
}

项目代码结构如下图：

eedd10c2d4a76010affa2e3f2fea2741.png

作者：anron

来源链接：

https://blog.csdn.net/anron/article/details/105180879

15658bb59b5a88e25fd699cb05fd9e09.png

Java知识日历
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
springboot使用校验框架validation校验的示例
08-27
主要介绍了springboot使用校验框架validation校验的示例,小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
spring boot验证框架
绅士jiejie的博客
01-20 832
在平时开发中，前端一般都会做参数的正确化校验，但是单单前端做校验是不够保险的，所以后端也需要加上相关的参数校验，防止有人绕过前端直接调用接口。 而spring boot就提供有这样的验证框架，默认实现用的是Hibernate validator。我们只需要将@Validated注解标注在方法参数上，spring boot就可以对参数进行校验，同时把校验结果放在BindingResult对象里。 ...
Spring Boot 中自定义中文校验注解的实现
最新发布
记录一下
01-04 656
首先，我们创建一个自定义注解@Chinese，用于标记需要进行中文校验的字段或参数。/*** 中文校验注解// 默认错误提示信息 String message() default "必须为中文字符";// 分组 Class <?// 负载 Class <?/*** 中文校验注解// 默认错误提示信息 String message() default "必须为中文字符";// 分组 Class <?// 负载 Class <?Constraint;/**
SpringBoot - jSR303校验的Message模板配置
Maggieq8324的博客
08-18 2793
目录前言具体实现Message模板配置模板参数配置 前言 jSR303参数校验可以查看之前的文章 SpringBoot - Bean validation 参数校验，这里介绍消息模板的配置。 具体实现 Message模板配置 /resources/目录下新增ValidationMessages.properties文件(固定文件名)，配置Message id.valid = id必须是正整数 全局异常处理器 import org.springframework.http.HttpStatus;
Java-validation
小安灬的博客
07-01 1482
@Valid 用于验证注解是否符合要求，直接加在变量之前，在变量中添加验证信息的要求，当不符合要求时就会在方法中返回message 的错误提示信息。 pom : <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactI...
Java Validation （验证注解）
木辰風的博客
07-04 921
验证注解 验证的数据类型 说明 @AssertFalse Boolean,boolean 验证注解的元素值是false @AssertTrue Boolean,boolean 验证注解的元素值是true @NotNull 任意类型 验证注解的元素值不是null @Null 任意类型 验证注解的元素值是null @Min(value=值) BigDecimal，BigInteger, byte,short, int, lon
springboot项目中判断字符串中是否有汉字
I心暖存人T的博客
11-22 3883
仅供学习，不得转载，有问题可以私聊 public boolean generateJudgment(String countname) { Pattern p = Pattern.compile("[\u4e00-\u9fa5]"); Matcher isNum = p.matcher(countname); if (isNum.find()) { return true; }
Java代码简洁-validation参数校验
weixin_43994244的博客
07-09 8192
validation参数校验
java使用Validation进行数据校验
weixin_46759354的博客
04-02 6037
把校验和业务逻辑分离开，让代码编写更加方便。Spring Validation其实就是对Hibernate Validator进一步的封装，方便在Spring中使用。
Spring MVC代码实例系列-12：使用自带的validation实现自定义message表单校验
韩超的博客 (hanchao5272)
02-10 3840
超级通道 ：Spring MVC代码实例系列-绪论 本章主要记录，如何在Spring MVC使用自带的validation实现自定义消息-表单校验。 1.历史回顾 在Spring MVC代码实例系列-06：Spring MVC配置Hibernate-Validator以及自定义校验注解中记录了如果通过注册自定义的校验驱动，配置自定义校验消息。 根据那篇文章记录的配置方式，实现了自定义m...
springboot+dubbo+validation 进行rpc参数校验的实现方法
08-25
主要介绍了springboot+dubbo+validation 进行rpc参数校验的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
SpringBoot使用validation-api实现参数校验的示例
09-08
主要介绍了SpringBoot使用validation-api实现参数校验的示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Spring自带的校验框架Validation的使用实例
08-26
今天小编就为大家分享一篇关于Spring自带的校验框架Validation的使用实例，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
springboot validator枚举值校验功能实现
08-25
主要介绍了springboot validator枚举值校验功能实现,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
java的validation框架（参数校验）
weixin_45703155的博客
04-20 7186
*** 自定义手机号注解*///注解的作用目标(可以设置作用在类，方法等等）@Target({ElementType.FIELD }) //注解的保留策略（注解的生命周期) @Retention(RetentionPolicy.RUNTIME) //不同之处：与注解关联的验证器//注解验证不通过时输出的信息String message() default "手机号验证错误";//约束注解在验证时所属的组别Class
SpringMVC验证框架Validation自定义注解实现传递参数到国际化资源文件
热门推荐
鹏霄万里展雄飞
12-04 2万+
关于SpringMVC验证框架Validation的使用方法，不是本篇的重点，可参见博文SpringMVC介绍之Validation 在使用Validation时，一定有朋友遇到过一个问题，那就是：无法传递参数到国际化资源文件properties错误描述中。
SpringBoot校验框架Validation及项目的国际化
anron的专栏
03-29 5059
一、概述 虽然前端系统对后台API接口调用之前都会做数据的校验，但是考虑到很多API接口是直接暴露在外网中，后台接口对传入的参数做校验是不可缺少的。比如判断字段非空，字段长度限制，邮箱格式验证等，这时就可以用到Validation。 二、创建Spring Boot工程 三、创建类 3.1 UserVo类 package com.anron.vo; import lomb...
utils.js,js工具类
vincent
02-25 1万+
http://runjs.cn/apidoc/classes/Utils.html   --utils.js中方法导航。 http://runjs.cn/apidoc/files/js_utils.js.html  ---代码实际地址 /**  * 模块工具类，用来初始化各模块视图、自定绑定事件以及其他辅助功能等  *  * @class Utils  */ Utils = (fu
java 校验不超过50个汉字_springboot自定义注解-注解校验，让代码更简洁
weixin_39712969的博客
11-26 2090
Java注解简介：Java注解又称Java标注，是JDK5.0版本开始支持加入源代码的特殊语法元数据。Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同，Java标注可以通过反射获取标注内容。在编译器生成类文件时，标注可以被嵌入到字节码中。Java虚拟机可以保留标注内容，在运行时可以获取到标注内容。 当然它也支持自定义Java标注。java元注解所在包java.lang....
使用java注解校验框架如何校验集合？请给一段示例
09-14
使用Java注解校验框架可以很方便地校验集合，只需要在集合类型的字段上加上相应的注解即可。 例如，使用Hibernate Validator校验框架，可以使用@Size注解来校验集合的大小，例如下面的示例： ```java import javax...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值