【springboot】 通过jdk8特性 优雅的写入日志（非常推荐） 解决@valid失效问题

前言

@valid 可以帮助我们节省很多代码 比较方便 但操作失误时 可能会失效 达不到我们预期效果；

@valid会有个问题 因为注解过于方便 反而会导致拦截后 错误日志的收集会比较麻烦 ，以及在面对有时需要拦截 有时不需要拦截的特定场景下 显得无计可施 此时我们还是要回归手写校验

本文将从解决@valid失效问题 及提供更灵活的方案两个方面进行简述

@valid失效问题

1. 检查依赖 单独引入validation-api可能无效 我们看看springboot给出的提示
   

		<!-- version 和springboot版本保持一致即可 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

2. 检查是否使用错误

需要校验的类添加@Validated注解（有接口的情况下 可加在接口 也可在实现类 推荐统一加在接口）

方法参数需要添加@Valid注解 (有接口的情况下 需要加在接口的方法参数)

实体类参数需要添加校验注解 如@NotNull 下面用代码举个例子

// 注意是 interface 
@Validated
public interface DeviceConfigService extends IService<DeviceConfigDO> {

    void putDeviceConfigList(@Valid DeviceConfigUpdaterCmd cmd);
}

@Data
@EqualsAndHashCode
public class DeviceConfigUpdaterCmd implements Serializable {

    private static final long serialVersionUID=1L;

    @NotNull(message = "错误")
    private Long id;
   }

替代方案

举个例子 我们项目和外部的接口进行对接 鉴于主动防御原则 我们可能对其某些参数进行校验，当id参数为空时 我们需要写入日志 方便快速定位(甩锅)问题

传统的写法是

if (null != cmd.getId){
  throw new RuntimeException("参数不能为空");
}

你是否也感觉一片的 if 看着很让人恼火 又无计可施呢?
再后来 可能我们会从spring源码中的断言类受到启发，用spring的姿势是这么去判断的

Assert.notNull(id,"不能为空");

	// spring的 Assert 类
    public static void notNull(@Nullable Object object, String message) {
        if (object == null) {
            throw new IllegalArgumentException(message);
        }
    }

但这随之而来有个很大的问题 ，我们如何打日志呢?

这个时候我们应该想到 jdk8开始 提供了函数式接口，我们可以直接将方法传入

比如Function Consumer 都可以做到，但是关键在于方法传入 如何让它执行呢？

所以我们选择了Consumer消费型函数，看完下面代码 我们就能很好的理解为什么它叫消费型函数了：

如果对Consumer不熟悉的同学 或许会感到疑惑 网上似乎都是此类教程，这到底有什么用？接着往下看 我们用函数式简化一下

我们能看出来，我们test()方法的参数 也是一个方法，并且accept会将该方法执行（消费），
且accept(T t)是必须要有参数的 ，

然而 我们写日志的时候 log.error(“msg”) ，这一步骤就够了 我们并不需要额外将 "msg” 交给accpet来处理，
那应该怎么办呢？

于是我们可以参数给定一个空串 ：

	// 自定义一个CommonAssert类
    public static void notNull(@Nullable Object object, String msg, Consumer consumer) {
        if (null == object) {
        	// 消费该方法 （执行该方法）
            consumer.accept("");
            throw new RuntimeException(msg);
        }
    }

使用方代码：

        CommonAssert.notNull(id, "id error", item -> log.error("id error"));

优化：

lambada表达式中 item指代的是accept(xx)里面的参数xx, 我们写入日志就变成了 item -> log.error(item)
简写 log::error

    public static void notNull(@Nullable Object object, String msg, Consumer<String> consumer) {
        if (null == object) {
        	// 消费该方法 （执行该方法）
            consumer.accept(msg);
            throw new RuntimeException(msg);
        }
    }

使用方代码：

        CommonAssert.notNull(id, "id error", log::error);
        // 或自定义日志
        CommonAssert.notNull(id, "id error", item -> log.error("your error msg"));