字段校验注解

最新推荐文章于 2024-07-12 17:58:20 发布
最新推荐文章于 2024-07-12 17:58:20 发布
阅读量477 收藏
点赞数
分类专栏： springCloud
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_28461661/article/details/115917499
版权

需要引入依赖

<dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>javax.servlet-api</artifactId>
            <version>4.0.1</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
            <version>6.0.13.Final</version>
        </dependency>

使用事例代码

package com.jm.domain;

import javax.validation.constraints.AssertTrue;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

import com.jm.validationGroup.Insert;
import lombok.Data;


@Data
public class Member {

    /*
    大苏打
     */
    @NotBlank(groups = Insert.class,message = "名称不能为空")
    @Size(min = 2,max = 5,message = "最小长度2，最大长度5")
    private String name;

    @NotBlank(message = "年级不能为空")
    private String age;

    @AssertTrue(message = "非男生")
    private boolean sex;
}


@PutMapping
    public String putMember( @Validated @RequestBody Member member){
        System.out.println("member="+member);

        int i = 1/Integer.parseInt(member.getAge());
        return "putMember";
    }

全局捕获异常

异常需要全局异常才能处理异常信息

package com.jm.exception.handler;

import com.fasterxml.jackson.databind.exc.InvalidFormatException;

import com.jm.common.ServiceResult;
import com.jm.constant.CodeEnum;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.servlet.http.HttpServletRequest;
import java.io.FileNotFoundException;
import java.util.List;

/**
 * @author ZhangZungan
 */
@Slf4j
@RestControllerAdvice()
public class GlobalExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ServiceResult handlerException(HttpServletRequest req, Exception e) {
        log.error(e.getMessage(), e);
        return ServiceResult.error(e.getMessage() == null ? e.toString() : e.getMessage());
    }



    @ExceptionHandler(FileNotFoundException.class)
    public ServiceResult handlerException(HttpServletRequest req, FileNotFoundException e) {
        log.error(e.getMessage());
        return ServiceResult.error(CodeEnum.FAILURE, "文件不存在");
    }


    @ExceptionHandler(ArithmeticException.class)
    public ServiceResult handlerException(HttpServletRequest req, ArithmeticException e){
        log.error(e.getMessage());
        return ServiceResult.error(CodeEnum.FAILURE, "算数运算异常");
    }

    /**
     * 参数校验
     *
     * @param req 请求
     * @param e   参数校验异常
     * @return ServiceResult
     */
    @ExceptionHandler(HttpMessageNotReadableException.class)
    @ResponseBody
    public ServiceResult handlerException(HttpServletRequest req, HttpMessageNotReadableException e) {
        log.error(e.getMessage());
        return ServiceResult.error(CodeEnum.INVALID_PARAMS, e.getMessage());
    }

    /**
     * 参数校验
     *
     * @param req 请求
     * @param e   参数校验异常
     * @return ServiceResult
     */
    @ExceptionHandler(InvalidFormatException.class)
    @ResponseBody
    public ServiceResult handlerException(HttpServletRequest req, InvalidFormatException e) {
        log.error(e.getMessage());
        return ServiceResult.error(CodeEnum.INVALID_PARAMS, "无效的数据格式！");
    }



    /**
     * body参数校验(带@RequestBody注解)
     *
     * @param req 请求
     * @param e   参数校验异常
     * @return ServiceResult
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public ServiceResult handlerException(HttpServletRequest req, MethodArgumentNotValidException e) {
        log.error(toStr(e));
        return ServiceResult.error(CodeEnum.INVALID_PARAMS, toStr(e));
    }

    /**
     * query参数校验(不带@RequestBody注解)
     *
     * @param req 请求
     * @param e   参数校验异常
     * @return ServiceResult
     */
    @ExceptionHandler(BindException.class)
    @ResponseBody
    public ServiceResult handlerException(HttpServletRequest req, BindException e) {
        log.error(toStr(e));
        return ServiceResult.error(CodeEnum.INVALID_PARAMS, toStr(e));
    }

    private String toStr(MethodArgumentNotValidException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        return "参数非法：" + fieldErrors.stream()
                .map(fieldError -> fieldError.getField() + ": " + fieldError.getDefaultMessage())
                .reduce((s, s2) -> s + ", " + s2).orElse("");
    }

    private String toStr(BindException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        return "参数非法：" + fieldErrors.stream()
                .map(fieldError -> fieldError.getField() + ": " + fieldError.getDefaultMessage())
                .reduce((s, s2) -> s + ", " + s2).orElse("");
    }

}

package com.jm.common;

/*
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements.  See the NOTICE file distributed with
 *   this work for additional information regarding copyright ownership.
 *   The ASF licenses this file to You under the Apache License, Version 2.0
 *   (the "License"); you may not use this file except in compliance with
 *   the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 *
 */


import com.fasterxml.jackson.databind.ObjectMapper;
import com.jm.constant.CodeEnum;

import lombok.Data;
import org.springframework.http.MediaType;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.Serializable;

/**
 * AjaxResult .
 *
 * @author xiaoyu
 */

@Data

public class ServiceResult<T> implements Serializable {

	private static final long serialVersionUID = -2792556188993845048L;


	private String code;


	private String msg;


	private T data;

	/**
	 * Instantiates a new Soul result.
	 */
	public ServiceResult() {

	}

	/**
	 * Instantiates a new Soul result.
	 *
	 * @param code
	 *            the code
	 * @param msg
	 *            the message
	 * @param data
	 *            the reqVo
	 */
	public ServiceResult(final String code, final String msg, final T data) {

		this.code = code;
		this.msg = msg;
		this.data = data;
	}

	/**
	 * return success.
	 *
	 * @return {@linkplain ServiceResult}
	 */
	public static ServiceResult success() {
		return success("成功");
	}

	/**
	 * return success.
	 *
	 * @param msg
	 *            msg
	 * @return {@linkplain ServiceResult}
	 */
	public static ServiceResult success(final String msg) {
		return success(msg, null);
	}

	/**
	 * return success.
	 *
	 * @param data
	 *            this is result reqVo.
	 * @return {@linkplain ServiceResult}
	 */
	public static <T> ServiceResult<T> success(final T data) {
		return success(null, data);
	}




	/**
	 * return success.
	 *
	 * @param msg
	 *            this ext msg.
	 * @param data
	 *            this is result reqVo.
	 * @return {@linkplain ServiceResult}
	 */
	public static <T> ServiceResult<T> success(final String msg, final T data) {
		return get(CodeEnum.OK.getCode(), msg, data);
	}

	/**
	 * return error .
	 *
	 * @param msg
	 *            error msg
	 * @return {@linkplain ServiceResult}
	 */
	public static ServiceResult error(final String msg) {
		return error(CodeEnum.FAILURE.getCode(), msg);
	}


	/**
	 * return error .
	 *
	 * @param code
	 *            error code
	 * @param msg
	 *            error msg
	 * @return {@linkplain ServiceResult}
	 */
	public static ServiceResult error(final String code, final String msg) {
		return get(code, msg, null);
	}


    public static ServiceResult error(final CodeEnum codeEnum) {
        return get(codeEnum.getCode(), codeEnum.getMsg(), null);
    }

    public static ServiceResult error(final CodeEnum codeEnum, final String msg) {
        return get(codeEnum.getCode(), msg, null);
    }

	public static <T> ServiceResult<T> error(final CodeEnum codeEnum, final T data) {
		return get(codeEnum.getCode(), codeEnum.getMsg(), data);
	}

    public static <T> ServiceResult<T> error(final CodeEnum codeEnum, final String msg, final T data) {
        return get(codeEnum.getCode(), msg, data);
    }

	/**
	 * return timeout .
	 *
	 * @param msg
	 *            error msg
	 * @return {@linkplain ServiceResult}
	 *
	 */
	public static ServiceResult timeout(final String msg) {
		return error(CodeEnum.REQUEST_TIMEOUT.getCode(), msg);
	}

	private static <T> ServiceResult<T> get(final String code, final String msg, final T data) {
		return new ServiceResult<>(code, msg, data);
	}

	public static void error(HttpServletResponse resp, String message) throws IOException {
		error(resp, message, 500);
	}

	public static void error(HttpServletResponse resp, String message, Integer httpState) throws IOException {
		error(resp, CodeEnum.FAILURE.getCode(), message, httpState);
	}

	public static void error(HttpServletResponse resp, String code, String message, Integer httpState) throws IOException {
		resp.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
		resp.setStatus(httpState);
		PrintWriter out = resp.getWriter();
		ServiceResult result = ServiceResult.error(code, message);
		String str = new ObjectMapper().writeValueAsString(result);
		out.write(str);
		out.flush();
		out.close();
	}

	public static void success(HttpServletResponse resp, String message) throws IOException {
		success(resp, message, null);
	}

	public static <T> void success(HttpServletResponse resp, String message, T data) throws IOException {
		resp.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
		PrintWriter out = resp.getWriter();
		ServiceResult result = ServiceResult.success(message, data);
		String str = new ObjectMapper().writeValueAsString(result);
		out.write(str);
		out.flush();
		out.close();
	}

	/**
	 * 根据service操作结果，返回成功或失败
	 * @param flag      service操作结果
	 * @param message   失败时的提示信息
	 * @return          ServiceResult
	 */
	public static ServiceResult result(boolean flag, String message){
		if (flag) {
			return success();
		}
		return error(message);
	}

}


package com.jm.constant;

/**
 * oes-live 全局响应码
 */
public enum CodeEnum {
    
    UNKNOW_ERROR("-1", "未知错误"),
    OK("0", "成功"),
    FAILURE("1", "失败"),
    REQUEST_TIMEOUT("408", "超时"),
    INVALID_PARAMS("2", "请求参数无效"),
    UNSUPPORTED_URI("3", "未知URI"),
    UNQUANXIAN("403", "无权限操作"),
    UNLOGIN("401", "账号或密码不正确"),
    PARAMS_ERROR("1000","请求参数错误"),
    DATABASE_ERROR("2002","数据库入库异常"),
    DELETE_ERROR("2003", "删除失败"),
    BATCH_DELETE_ERROR("2004", "未勾选，请选中后删除"),
    JSON_ERROR("2010", "json转换异常"),
    PARSE_DATETIME_ERROR("2011", "时间格式转换错误"),

    CHANNEL_ERROR("9998","渠道分发错误"),

    PARAMS_EMPTY("2101","请求参数为空"),
    IS_EXIST("2103","信息已存在"),
    ISNULL("2104","信息不存在"),
    NOT_NUMBER("2105","必须为数字"),
    PHOTO_MISS("2106","图片上传失败"),
    PHOTO_SIZE_ERROR("2108","图片大小错误"),
    PHOTO_FILE_ERROR("2109","图片文件错误"),
    PHOTO_SPEC_ERROR("2110","图片规格错误"),
    CAPTCHA_SEND_ERROR("2107","短信验证码发送失败"),
    
    LOGIN_ERROR("2200", "账号或密码不正确"),
    USER_FORBID("2201", "用户被禁用"),
    INVALID_TOKEN("2202", "用户认证失败，请重新登录"),
    EXPIRED_TOKEN("2203", "Token已过期，请重新登录"),
    ISNULL_TOKEN("2204", "无效token，请重新登录"),


    REPEATED_ADD("3202", "重复添加"),
    USER_NOT_FOUND("3203", "用户不存在"),
    USER_PASSWD_ERROR("3204", "用户密码不正确"),
    USER_DEFAULT_PASSWD_ERROR("3205", "原密码不正确"),
    USER_CODE_EXIST("3206", "工号已被使用"),
    ROLE_REPEATED("3207", "角色名称重复"),
    USER_DEPARTMENT_NAME_ERROR("3208", "部门名称错误"),
    RESOURCE_REPEATED("3209", "角色名称重复"),
    ROLE_NOT_FOUND("3210", "角色不存在"),
    ROLE_PARAMS_ERROR("3211", "角色参数错误"),
    EXPORT_USER_IS_NULL("3212", "导入信息为空"),

    IMPORT_ERROR("4001", "Excel导入异常！"),
    EXPORT_ERROR("4002", "Excel导出异常！"),
    NULL_POINTER_ERROR("4003", "空指针异常"),

    CAPTCHA_EXPIRED_ERROR("4004", "验证码已过期,请重新获取验证码"),
    CAPTCHA_ERROR("4005", "验证码不正确"),
    USER_LOCKED("4006", "该账号已被锁定4H"),
    ERROR_FOUR("4007","您的密码已连续输入错误4次，输错5次将锁定账号4小时" ),
    PSAA_ERROR("4008","用户名或密码错误" ),
    USER_CHANGE_ERROR("4009","切换用户，请刷新页面重新登录" ),

    CUSTON_ERROR("9999", " 其它，自定义错误");


    private String code;
    private String msg;

    private CodeEnum(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public String getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}
Jerry_carry
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
注解+反射实现自定义验证工具，可实现业务校验，字段多种校验
09-17
通过注解+反射实现自定义验证 工具，可扩展业务校验，一个字段可进行多种校验，如：字段A需要大于字段B并且字段B需要大于字段C并且.....XXX。附使用文档以及源码
使用注解校验字段
hanwenqiang1995的博客
11-03 1081
使用注解校验字段 我们用一个类接收前端传来的数据时，有些字段是必须的。相信很多人都是通过if else来进行判断的，但是现在我们可以通过注解的方式来进行判断，这样代码可以更简洁。步骤如下： 1.引入maven依赖 <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <v
@Valid注解字段校验
最新发布
刘皇叔说Java的博客
07-12 852
这种做法首先是可取的，能达到我们的要求，但是这样如果model字段过多，判定的就很多，相对维护起来就不是那么方便，其次增加controller层的负担，既然我们来到spring4的时代，就应该适应使用注解的趋势，下面是使用注解后的比变化。搭建springboot项目，我们都是采用的Restful接口，那么问题来了，当前端调用接口或者是其他项目调用时，我们不能单一靠调用方来控制参数的准确性，自己也要对一些非空的值进行判定。在Java中，可以使用各种框架和库来进行字段校验，并使用相应的注解来定义校验规则。
Thymeleaf 表单 验证注解
热门推荐
05-15 1万+
Thymeleaf 表单 验证注解 JSR提供的校验注解： @Null 被注释的元素必须为 null @NotNull 被注释的元素必须不为 null @AssertTrue 被注释的元素必须为 true @AssertFalse 被...
一些常用的字段验证的注解
m0_58654474的博客
01-30 228
一些常用的字段验证的注解
使用 @Valid 注解实现各种字段的格式校验
weixin_44823875的博客
07-06 2842
在使用 @Valid 注解之前，要先引入依赖（如果是 Spring Boot 项目的话，就不需要专门引入依赖了，spring-boot-starter-web 已经帮我们引入好了）通过if-else的判断来实现字段校验，可以实现需求。但是对业务代码入侵比较严重，如果此时需要校验的字段越来越多，业务代码里校验的代码就会越来越多，导致业务代码丧失可读性。（1）给学生对象前增加上 @Valid 注解，就表示了我们需要对这个对象中的属性进行验证，验证的内容就是在学生类中增加的注解中的内容。（4）配合全局异常捕获。
jsp字段校验与非字段校验
06-17
**JSP字段校验与非字段校验** 在Web开发中，数据验证是必不可少的一环，它可以确保用户输入的数据符合应用程序的要求，防止错误的数据进入系统。JSP（JavaServer Pages）作为Java EE平台上的动态网页技术，提供了...
excel导入动态校验，自定义注解动态校验
06-09
3. **应用注解**：在数据模型或字段上使用自定义注解，指示哪些字段需要进行特定的校验。 4. **处理导入**：当导入Excel文件时，读取每个单元格的数据，并根据所应用的注解进行动态校验。如果数据不符合注解定义的...
java后台注解校验工具类
04-23
在Java开发中，后台注解校验是一种常见且强大的功能，它允许开发者通过在模型类的属性上添加特定的注解来定义数据验证规则。这种校验方式不仅可以提高代码的可读性和可维护性，还能在运行时动态检查输入数据的有效性...
Spring Boot技术知识点：如何使用@Validated注解来对邮箱字段进行数据校验
07-04
Spring Boot技术知识点：如何使用@Validated注解来对邮箱字段进行数据校验
Java开发中的常用字段校验注解
ray的博客
06-15 549
在 Java 开发中，数据校验是确保应用程序的数据完整性和一致性的重要步骤。通过使用这些注解，可以有效地简化 Java 开发中的数据校验工作，确保应用程序的数据完整性和一致性。希望这些示例代码能帮助你更好地理解它们的用法和作用。
springboot注解@NotNull，@NotBlank，@Valid自动判定空值
weixin_30856725的博客
01-22 8133
一、前言 搭建springboot项目，我们都是采用的Restful接口，那么问题来了，当前端调用接口或者是其他项目调用时，我们不能单一靠调用方来控制参数的准确性，自己也要对一些非空的值进行判定。 二、方案 按照我们以往的做法，都是对request中的参数一个一个进行非空判定。 Model： 1 public class Ord...
java校验字段的一些注解区别
锐rui3g的博客
07-26 238
规则校验注解使用 @NotEmpty 用在集合类上面 @NotBlank 用在String上面 @NotNull 用在基本类型上
Spring Validation校验框架@Validated注解常规校验，分组校验的使用，以及搭配全局异常处理器一起使用。
不经意的博客
04-26 3374
注：Sring Validation验证框架对参数的校验机制提供了@Validated（SpringJSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），配合BindingResult可以直接提供参数验证结果。 @Validated配合BindingResult使用个人觉得比较死板，如果不做处理测试校验结果只能校验出有数据不符合制...
Java：基于注解对类实例字段进行通用校验
江南好
01-01 2700
抽象方法参数model的字段校验代码
分享几个实用的参数校验注解（含字段依赖校验、枚举字段值有效性校验、参数类型转换）
u010473656的专栏
01-06 1887
几个实用的自定义校验注解
使用 @Valid 注解实现字段校验
栗少的博客
04-11 2571
每一个应用软件都离不开数据的校验，比如在提交表单时需要对用户提交的字段内容进行长度验证、非空验证等等。有的小伙伴在做字段内容校验时采用的依然是最原始的校验方式——获取字段内容，用 if-else 对内容进行验证。这种校验方式当然没问题，但是却需要写很多行代码去实现校验的功能，也就让我们的编码效率和代码可读性都降低了很多，那么今天就给各位小伙伴介绍另一种方式——使用 @Valid 注解实现字段校验。 字段校验 首先我们先新建一个学生类（类也很简单，只有姓名和年龄两个字段）👇 /** * 学生类 *
SpringBoot表单验证
weixin_40455265的博客
09-30 1037
限制 说明 @Null 限制只能为null @NotNull 限制必须不为null @AssertFalse 限制必须为false @AssertTrue 限制必须为true @DecimalMax(value) 限制必须为一个不大于指定值的数字 @DecimalMin(
Spring Boot字段校验注解
weixin_44000378的博客
04-19 958
Spring Boot字段校验注解无效问题第一种情况（缺少必须注解@Valid）第二种情况（springboot版本太高问题） 在使用字段校验注解：@NotNull、@NotEmpty、@NotBlank的时候无效问题。 无效的两种情况： 第一种情况（缺少必须注解@Valid） 1、在需要校验的JavaBean字段加注解 @Data @TableName(value = "sys_report_model") public class SysReportModel { @TableId @N
校验字段改名的所有注解
05-25
在Java中，有以下几种常用的校验注解可以用来验证字段： 1. @NotNull：字段不能为空 2. @NotBlank：字符串字段不能为空，且长度必须大于0 3. @NotEmpty：集合字段不能为空，且其中元素个数必须大于0 4. @Size：字段...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值