Spring Dao層@Repository與@Mapper的使用

2022-02-26 19:02:52

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);
    }
}

使用這種方法，介面上不用新增任何註解。