Spring Boot--08--Mybatis 之Mapper在IDEA中自动注入警告的解决方案

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

文章目录

• 问题
• • 原因
  • 解决方案
  • • 方法1：为 @Autowired 注解设置required = false
    • 方法2：用 @Resource 替换 @Autowired
    • 方法3：在Mapper接口上加上@Repository注解
    • 方法4：用Lombok
    • 方法5：把IDEA的警告关闭掉

      ---

      问题

      @MapperScan(“com.zyp.mapper”)或者@Mapper注解修饰持久层时，借助@autowire注入持久层对象则报错，报错如图

      

      

      可以看到 userMapper 下有个红色警告。虽然代码本身并没有问题，能正常运行，但有个警告总归有点恶心。

      原因

      IDEA是非常智能的，它可以理解Spring的上下文。然而 UserMapper 这个接口是Mybatis的，IDEA理解不了。

      而 @Autowired 注解，默认情况下要求依赖对象（也就是 userMapper ）必须存在。而IDEA认为这个对象的实例/代理是个null，所以就友好地给个提示。

      解决方案

      方法1：为 @Autowired 注解设置required = false

      使用 @Autowired 注解时，若希望允许null值，可设置required = false，像这样：

      @Autowired(required = false)
      private UserMapper userMapper;
      

      这样就不会有警告了。原因很好理解：IDEA认为userMapper是个null，给了警告；加上required = false后，使用 @Autowired 注解不再去校验userMapper是否存在了。也就不会有警告了。

      但是一个庞大的项目，可能到处都在引用Mapper，如果只是为了解决IDEA的警告，到处都补上 required = false，工作量不划算啊。而且也很难理解这里只是为了解决IDEA的警告才加上的。

      方法2：用 @Resource 替换 @Autowired

      @Resource
      private UserMapper userMapper;
      

      这样也不会出现警告。可以参考：@Autowired 与@Resource的区别

      但是和方法一一个道理，一个项目已经大量使用@Autowired，然后为了这个警告到处改成@Resource，感觉没什么必要。

      方法3：在Mapper接口上加上@Repository注解

      @Repository
      public interface UserMapper {
      

      用@Component替换@Repository也是可以的。

      原理大致：IDEA认为 userMapper 是个null，我们加个@Repository注解骗一下IDEA就行了。

      总结：这种方式比较推荐，改动小，也简单，也可以更直观的看出是被Spring容器管理的bean。

      方法4：用Lombok

      @Service
      @RequiredArgsConstructor(onConstructor = @__(@Autowired))
      public class TestService {
          private final UserMapper userMapper;
      }
      

      记得一定要在被注入的字段上加上private final关键字，否则不会自动注入。

      Lombok生成的代码是这样的：

      @Service
      public class TestService {
          private final UserMapper userMapper;
          @Autowired
          public TestService(final UserMapper userMapper) {
              this.userMapper = userMapper;
          }
      }
      

      发现Lombook生成的代码使用了构造方法注入方式来注入bean的。

      Spring官方并不建议直接在类的field上使用@Autowired注解。

      不用在每个field上都加上@Autowired注解了。

      缺点：那就是如果你类之间的依赖关系比较复杂，特别是存在循环依赖(A引用B，B引用A，或者间接引用)时，引用将会启动不起来，这其实是构造方法注入方式的缺点。

      方法5：把IDEA的警告关闭掉

      将@Autowired警告级别从error降低为warning。设置如下：