@RequiredArgsConstructor如何實(shí)現(xiàn)構(gòu)造器注入

更新時(shí)間：2024年09月04日 15:56:23 作者：しろいし

這篇文章主要介紹了@RequiredArgsConstructor如何實(shí)現(xiàn)構(gòu)造器注入問題,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

@RequiredArgsConstructor實(shí)現(xiàn)構(gòu)造器注入

1.@Autowired和@Resource 注解

@Autowired
@Autowired 是 Spring 框架提供的注解，用于自動(dòng)裝配依賴。
可以用于字段、構(gòu)造函數(shù)和 setter 方法。

@Autowired
private ISysUserService userService;

@Resource
@Resource 是 Java EE 提供的注解，Spring 也支持它，用于自動(dòng)裝配依賴。
一般用于字段和 setter 方法。

@Resource
private ISysUserService userService;

2.構(gòu)造函數(shù)注入

使用 Lombok 的 @RequiredArgsConstructor

springboot @RequiredArgsConstructor的概念與使用

@RequiredArgsConstructor 是 Lombok 提供的注解，它會自動(dòng)生成包含所有 final 字段的構(gòu)造函數(shù)。
使用構(gòu)造函數(shù)注入可以確保依賴注入在對象創(chuàng)建時(shí)完成，確保所有依賴都是非空的。

@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;
    
    // 構(gòu)造函數(shù)由 Lombok 自動(dòng)生成，注入所有 final 字段
}

3.比較和優(yōu)點(diǎn)

字段注入（@Autowired 和 @Resource）

優(yōu)點(diǎn)：代碼簡潔，直接在字段上注解。

缺點(diǎn)：

難以進(jìn)行單元測試，因?yàn)樾枰ㄟ^反射或其他方式注入 mock 對象。
依賴注入發(fā)生在對象創(chuàng)建之后，可能導(dǎo)致依賴未完全初始化的問題。
違反了依賴倒置原則，類直接依賴于容器。

構(gòu)造函數(shù)注入

優(yōu)點(diǎn)：

強(qiáng)制依賴在對象創(chuàng)建時(shí)就完全初始化，確保所有依賴非空。
更容易進(jìn)行單元測試，因?yàn)榭梢酝ㄟ^構(gòu)造函數(shù)注入 mock 對象。
更符合依賴倒置原則，使類更獨(dú)立于容器。
提升了代碼的可讀性和可維護(hù)性，尤其是當(dāng)依賴較多時(shí)。

缺點(diǎn)：

需要額外的構(gòu)造函數(shù)代碼，但使用 Lombok 的 @RequiredArgsConstructor 可以減輕這個(gè)負(fù)擔(dān)。

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;

    // 其他代碼
}

使用構(gòu)造函數(shù)注入

@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;

    // 其他代碼
}

通過這種構(gòu)造函數(shù)注入的方式，不僅可以增強(qiáng)代碼的健壯性和可維護(hù)性，還可以更好地利用 Spring 的依賴注入特性和 Lombok 的簡化代碼的優(yōu)勢。

好處

Spring的構(gòu)造器注入

5.關(guān)于注解

在使用構(gòu)造函數(shù)注入時(shí)，不需要額外添加注解，只需要提供構(gòu)造函數(shù)即可。Spring 會自動(dòng)檢測到你的構(gòu)造函數(shù)并進(jìn)行依賴注入。

使用構(gòu)造函數(shù)注入，不需要額外注解

@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;

    // 自己編寫構(gòu)造函數(shù)
    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;
    }
}

使用構(gòu)造函數(shù)注入的要點(diǎn)

1.定義構(gòu)造函數(shù)：

在類中定義一個(gè)包含所有需要依賴的構(gòu)造函數(shù)。

2.Spring 自動(dòng)注入：

Spring 在創(chuàng)建 Bean 實(shí)例時(shí)，會自動(dòng)識別并調(diào)用該構(gòu)造函數(shù)，同時(shí)注入所需的依賴。

示例代碼

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;

    // 構(gòu)造函數(shù)注入
    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;
    }

    // 你的控制器方法
}

在這個(gè)例子中，不需要使用任何額外的注解來標(biāo)注構(gòu)造函數(shù)，Spring 會自動(dòng)識別并注入依賴。（當(dāng)然，標(biāo)注了也不會報(bào)錯(cuò)，但是只能使用@Autowired，不能使用@Resouce，@Resource 注解通常用于字段或 setter 方法注入）

額外情況

多個(gè)構(gòu)造函數(shù)：

如果一個(gè)類中有多個(gè)構(gòu)造函數(shù)，并且其中只有一個(gè)構(gòu)造函數(shù)有注入?yún)?shù)，Spring 會使用這個(gè)構(gòu)造函數(shù)進(jìn)行注入。
如果有多個(gè)構(gòu)造函數(shù)都有注入?yún)?shù)，則需要使用 @Autowired 注解來明確指定使用哪個(gè)構(gòu)造函數(shù)。

示例代碼（多個(gè)構(gòu)造函數(shù)）

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 明確指定使用哪個(gè)構(gòu)造函數(shù)
    @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;
    }

    // 另一個(gè)構(gòu)造函數(shù)
    public SysUserController(ISysUserService userService) {
        this.userService = userService;
        this.roleService = null;
        this.postService = null;
        this.deptService = null;
        this.userPostService = null;
    }

    // 你的控制器方法
}

在這個(gè)例子中，由于存在多個(gè)構(gòu)造函數(shù)，需要使用 @Autowired 注解來明確指定 Spring 使用哪個(gè)構(gòu)造函數(shù)進(jìn)行依賴注入。