@RequiredArgsConstructor如何实现构造器注入

 更新时间:2024年09月04日 15:56:23   作者:しろいし  
这篇文章主要介绍了@RequiredArgsConstructor如何实现构造器注入问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

@RequiredArgsConstructor实现构造器注入

1.@Autowired和@Resource 注解

  • @Autowired
  • @Autowired 是 Spring 框架提供的注解,用于自动装配依赖。
  • 可以用于字段、构造函数和 setter 方法。
@Autowired
private ISysUserService userService;
  • @Resource
  • @Resource 是 Java EE 提供的注解,Spring 也支持它,用于自动装配依赖。
  • 一般用于字段和 setter 方法。
@Resource
private ISysUserService userService;

2.构造函数注入

使用 Lombok 的 @RequiredArgsConstructor

springboot @RequiredArgsConstructor的概念与使用

  • @RequiredArgsConstructor 是 Lombok 提供的注解,它会自动生成包含所有 final 字段的构造函数。
  • 使用构造函数注入可以确保依赖注入在对象创建时完成,确保所有依赖都是非空的。
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/user")
public class SysUserController extends BaseController {
    private final ISysUserService userService;
    private final ISysRoleService roleService;
    private final ISysPostService postService;
    private final ISysDeptService deptService;
    private final ISysUserPostService userPostService;
    
    // 构造函数由 Lombok 自动生成,注入所有 final 字段
}

3.比较和优点

字段注入(@Autowired@Resource

优点:代码简洁,直接在字段上注解。

缺点

  • 难以进行单元测试,因为需要通过反射或其他方式注入 mock 对象。
  • 依赖注入发生在对象创建之后,可能导致依赖未完全初始化的问题。
  • 违反了依赖倒置原则,类直接依赖于容器。

构造函数注入

优点

  • 强制依赖在对象创建时就完全初始化,确保所有依赖非空。
  • 更容易进行单元测试,因为可以通过构造函数注入 mock 对象。
  • 更符合依赖倒置原则,使类更独立于容器。
  • 提升了代码的可读性和可维护性,尤其是当依赖较多时。

缺点

  • 需要额外的构造函数代码,但使用 Lombok 的 @RequiredArgsConstructor 可以减轻这个负担。

4. 示例对比

使用 @Autowired

@RestController
@RequestMapping("/system/user")
public class SysUserController extends BaseController {
    
    @Autowired
    private ISysUserService userService;
    
    @Autowired
    private ISysRoleService roleService;
    
    @Autowired
    private ISysPostService postService;
    
    @Autowired
    private ISysDeptService deptService;
    
    @Autowired
    private ISysUserPostService userPostService;

    // 其他代码
}

使用构造函数注入

@RequiredArgsConstructor
@RestController
@RequestMapping("/system/user")
public class SysUserController extends BaseController {
    private final ISysUserService userService;
    private final ISysRoleService roleService;
    private final ISysPostService postService;
    private final ISysDeptService deptService;
    private final ISysUserPostService userPostService;

    // 其他代码
}

通过这种构造函数注入的方式,不仅可以增强代码的健壮性和可维护性,还可以更好地利用 Spring 的依赖注入特性和 Lombok 的简化代码的优势。

好处

Spring的构造器注入

5.关于注解

在使用构造函数注入时,不需要额外添加注解,只需要提供构造函数即可。Spring 会自动检测到你的构造函数并进行依赖注入。

使用构造函数注入,不需要额外注解

@RestController
@RequestMapping("/system/user")
public class SysUserController extends BaseController {
    private final ISysUserService userService;
    private final ISysRoleService roleService;
    private final ISysPostService postService;
    private final ISysDeptService deptService;
    private final ISysUserPostService userPostService;

    // 自己编写构造函数
    public SysUserController(ISysUserService userService, 
                             ISysRoleService roleService, 
                             ISysPostService postService, 
                             ISysDeptService deptService, 
                             ISysUserPostService userPostService) {
        this.userService = userService;
        this.roleService = roleService;
        this.postService = postService;
        this.deptService = deptService;
        this.userPostService = userPostService;
    }
}

使用构造函数注入的要点

1.定义构造函数:

在类中定义一个包含所有需要依赖的构造函数。

2.Spring 自动注入:

Spring 在创建 Bean 实例时,会自动识别并调用该构造函数,同时注入所需的依赖。

示例代码

package com.example.demo.controller;

import com.example.demo.service.ISysUserService;
import com.example.demo.service.ISysRoleService;
import com.example.demo.service.ISysPostService;
import com.example.demo.service.ISysDeptService;
import com.example.demo.service.ISysUserPostService;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/system/user")
public class SysUserController {

    private final ISysUserService userService;
    private final ISysRoleService roleService;
    private final ISysPostService postService;
    private final ISysDeptService deptService;
    private final ISysUserPostService userPostService;

    // 构造函数注入
    public SysUserController(ISysUserService userService, 
                             ISysRoleService roleService, 
                             ISysPostService postService, 
                             ISysDeptService deptService, 
                             ISysUserPostService userPostService) {
        this.userService = userService;
        this.roleService = roleService;
        this.postService = postService;
        this.deptService = deptService;
        this.userPostService = userPostService;
    }

    // 你的控制器方法
}

在这个例子中,不需要使用任何额外的注解来标注构造函数,Spring 会自动识别并注入依赖。(当然,标注了也不会报错,但是只能使用@Autowired,不能使用@Resouce,@Resource 注解通常用于字段或 setter 方法注入)

额外情况

多个构造函数:

  • 如果一个类中有多个构造函数,并且其中只有一个构造函数有注入参数,Spring 会使用这个构造函数进行注入。
  • 如果有多个构造函数都有注入参数,则需要使用 @Autowired 注解来明确指定使用哪个构造函数。

示例代码(多个构造函数)

package com.example.demo.controller;

import com.example.demo.service.ISysUserService;
import com.example.demo.service.ISysRoleService;
import com.example.demo.service.ISysPostService;
import com.example.demo.service.ISysDeptService;
import com.example.demo.service.ISysUserPostService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/system/user")
public class SysUserController {

    private final ISysUserService userService;
    private final ISysRoleService roleService;
    private final ISysPostService postService;
    private final ISysDeptService deptService;
    private final ISysUserPostService userPostService;

    // 使用 @Autowired 明确指定使用哪个构造函数
    @Autowired
    public SysUserController(ISysUserService userService, 
                             ISysRoleService roleService, 
                             ISysPostService postService, 
                             ISysDeptService deptService, 
                             ISysUserPostService userPostService) {
        this.userService = userService;
        this.roleService = roleService;
        this.postService = postService;
        this.deptService = deptService;
        this.userPostService = userPostService;
    }

    // 另一个构造函数
    public SysUserController(ISysUserService userService) {
        this.userService = userService;
        this.roleService = null;
        this.postService = null;
        this.deptService = null;
        this.userPostService = null;
    }

    // 你的控制器方法
}

在这个例子中,由于存在多个构造函数,需要使用 @Autowired 注解来明确指定 Spring 使用哪个构造函数进行依赖注入。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Spring-AOP @AspectJ切点函数之@annotation()用法

    Spring-AOP @AspectJ切点函数之@annotation()用法

    这篇文章主要介绍了Spring-AOP @AspectJ切点函数之@annotation()用法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • IDEA maven引入SSL证书校验问题及处理

    IDEA maven引入SSL证书校验问题及处理

    这篇文章主要讨论了在Maven项目中遇到依赖导入问题,特别是关于PKIX路径构建失败的错误,文章提供了三种解决方法:手动下载依赖、忽略SSL证书校验以及生成并导入SSL证书,每种方法都有详细的步骤和示例代码,帮助开发者解决这个问题
    2025-02-02
  • MyBatis 配置复用从入门到精通

    MyBatis 配置复用从入门到精通

    本文将深入探讨MyBatis的各种配置复用技巧,帮助您写出更优雅、更易维护的持久层代码,本文结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧
    2026-03-03
  • Springcloud eureka搭建高可用集群过程图解

    Springcloud eureka搭建高可用集群过程图解

    这篇文章主要介绍了Springcloud eureka搭建高可用集群过程图解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • 线程池ThreadPoolExecutor应用过程

    线程池ThreadPoolExecutor应用过程

    这篇文章主要介绍了如何使用ThreadPoolExecutor创建线程池,包括其构造方法、常用方法、参数校验以及如何选择合适的拒绝策略,文章还讨论了为什么应该强制要求使用ThreadPoolExecutor创建线程池,并提供了在项目和Spring中创建线程池的示例
    2025-12-12
  • Java使用freemarker实现word下载方式

    Java使用freemarker实现word下载方式

    文章介绍了如何使用FreeMarker实现Word文件下载,包括引用依赖、创建Word模板、将Word文件存为XML格式、更改后缀为FTL模板、处理图片和代码实现
    2025-02-02
  • Java处理科学计数法数字方式

    Java处理科学计数法数字方式

    这篇文章主要介绍了Java处理科学计数法数字方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-07-07
  • Java使用Ajax异步上传文件

    Java使用Ajax异步上传文件

    使用Ajax上传文件的应用场景颇多,比如上传用户头像、博客文章中插入图片、对认证用户相关身份进行校验等等很多很多。本文提供一个简单的示例供大家参考
    2021-05-05
  • windows系统上如何进行maven安装和配置方式

    windows系统上如何进行maven安装和配置方式

    这篇文章主要介绍了windows系统上如何进行maven安装和配置方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-05-05
  • Springboot使用pdfbox提取PDF图片的代码示例

    Springboot使用pdfbox提取PDF图片的代码示例

    PDFBox是一个用于创建和处理PDF文档的Java库,它可以使用Java代码创建、读取、修改和提取PDF文档中的内容,本文就给大家介绍Springboot如何使用pdfbox提取PDF图片,感兴趣的同学可以借鉴参考
    2023-06-06

最新评论