Spring Dao層@Repository與@Mapper的使用

Posted on 2022-02-26 by WalkonNet

Spring Dao層@Repository與@Mapper

使用註解的方式開發Dao層的時候，常常會混淆這兩個註解，不知道怎麼添加，這裡做個記錄。

1、@Mapper

@Mapper 是 Mybatis 的註解，和 Spring 沒有關系，@Repository 是 Spring 的註解，用於聲明一個 Bean。（重要）

使用 Mybatis 有 XML 文件或者註解的兩種使用方式，如果是使用 XML 文件的方式，我們需要在配置文件中指定 XML 的位置，這裡隻研究註解開發的方式。

在 Spring 程序中，Mybatis 需要找到對應的 mapper，在編譯的時候動態生成代理類，實現數據庫查詢功能，所以我們需要在接口上添加 @Mapper 註解。

@Mapper
public interface UserDao {
	...
}

但是，僅僅使用@Mapper註解，我們會發現，在其他變量中依賴註入，IDEA 會提示錯誤，但是不影響運行（親測～）。因為我們沒有顯式標註這是一個 Bean，IDEA 認為運行的時候會找不到實例註入，所以提示我們錯誤。如下圖，會有紅色波浪線。

盡管這個錯誤提示並不影響運行，但是看起來很不舒服，所以我們可以在對應的接口上添加 bean 的聲明，如下：

@Repository // 也可以使用@Component，效果都是一樣的，隻是為瞭聲明為bean
@Mapper
public interface UserDao {
	
	@Insert("insert into user(account, password, user_name) " +
            "values(#{user.account}, #{user.password}, #{user.name})")
    int insertUser(@Param("user") User user) throws RuntimeException;
}

2、@Repository

正如上面說的，@Repository 用於聲明 dao 層的 bean，如果我們要真正地使用 @Repository 來進行開發，那是基於代碼的開發，簡單來說就是手寫 JDBC。

和 @Service、@Controller 一樣，我們將 @Repository 添加到對應的實現類上，如下：

@Repository
public class UserDaoImpl implements UserDao{
	
	@Override
	public int insertUser(){
		JdbcTemplate template = new JdbcTemplate();
		...
	}
}

3、其他掃描手段

基於註解的開發也有其他手段幫助 Mybatis 找到 mapper，那就是 @MapperScan 註解，可以在啟動類上添加該註解，自動掃描包路徑下的所有接口。

@SpringBootApplication
@MapperScan("com.scut.thunderlearn.dao")
public class UserEurekaClientApplication {
    public static void main(String[] args) {
        SpringApplication.run(UserEurekaClientApplication.class, args);
    }
}

使用這種方法，接口上不用添加任何註解。

4、小結

@Mapper：一定要有，否則 Mybatis 找不到 mapper。
@Repository：可有可無，可以消去依賴註入的報錯信息。
@MapperScan：可以替代 @Mapper。

@Mapper和@Repository的區別

1、相同點

@Mapper和@Repository都是作用在dao層接口，使得其生成代理對象bean，交給spring 容器管理

對於mybatis來說，都可以不用寫mapper.xml文件

2、不同點

@Mapper不需要配置掃描地址，可以單獨使用，如果有多個mapper文件的話，可以在項目啟動類中加入@MapperScan(“mapper文件所在包”)，這樣就不需要每個mapper文件都加@Mapper註解瞭
@Repository不可以單獨使用，否則會報如下錯誤

Field userMapper in com.liu.service.UserServiceImpl required a bean of type 'com.liu.mapper.UserMapper' that could not be found.

找不到bean，這是因為項目啟動的時候沒有去掃描使用@Repository註解的文件，所以使用@Repository需要配置掃描地址

但在idea中，使用@Repository可以消除在業務層中註入mapper對象時的錯誤，如下圖所示

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

Spring Dao層@Repository與@Mapper的使用

目錄