Spring Dao層@Repository與@Mapper的使用

更新時(shí)間：2022年02月26日 15:28:03 作者：Jalen Xu

這篇文章主要介紹了Spring Dao層@Repository與@Mapper的使用方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

Spring Dao層@Repository與@Mapper

使用注解的方式開發(fā)Dao層的時(shí)候，常常會(huì)混淆這兩個(gè)注解，不知道怎么添加，這里做個(gè)記錄。

1、@Mapper

@Mapper 是 Mybatis 的注解，和 Spring 沒(méi)有關(guān)系，@Repository 是 Spring 的注解，用于聲明一個(gè) Bean。（重要）

使用 Mybatis 有 XML 文件或者注解的兩種使用方式，如果是使用 XML 文件的方式，我們需要在配置文件中指定 XML 的位置，這里只研究注解開發(fā)的方式。

在 Spring 程序中，Mybatis 需要找到對(duì)應(yīng)的 mapper，在編譯的時(shí)候動(dòng)態(tài)生成代理類，實(shí)現(xiàn)數(shù)據(jù)庫(kù)查詢功能，所以我們需要在接口上添加 @Mapper 注解。

@Mapper
public interface UserDao {
	...
}

但是，僅僅使用@Mapper注解，我們會(huì)發(fā)現(xiàn)，在其他變量中依賴注入，IDEA 會(huì)提示錯(cuò)誤，但是不影響運(yùn)行（親測(cè)～）。因?yàn)槲覀儧](méi)有顯式標(biāo)注這是一個(gè) Bean，IDEA 認(rèn)為運(yùn)行的時(shí)候會(huì)找不到實(shí)例注入，所以提示我們錯(cuò)誤。如下圖，會(huì)有紅色波浪線。

盡管這個(gè)錯(cuò)誤提示并不影響運(yùn)行，但是看起來(lái)很不舒服，所以我們可以在對(duì)應(yīng)的接口上添加 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

正如上面說(shuō)的，@Repository 用于聲明 dao 層的 bean，如果我們要真正地使用 @Repository 來(lái)進(jìn)行開發(fā)，那是基于代碼的開發(fā)，簡(jiǎn)單來(lái)說(shuō)就是手寫 JDBC。

和 @Service、@Controller 一樣，我們將 @Repository 添加到對(duì)應(yīng)的實(shí)現(xiàn)類上，如下：

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

3、其他掃描手段

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

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

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

4、小結(jié)

@Mapper：一定要有，否則 Mybatis 找不到 mapper。
@Repository：可有可無(wú)，可以消去依賴注入的報(bào)錯(cuò)信息。
@MapperScan：可以替代 @Mapper。

@Mapper和@Repository的區(qū)別

1、相同點(diǎn)

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

對(duì)于mybatis來(lái)說(shuō)，都可以不用寫mapper.xml文件

2、不同點(diǎn)

@Mapper不需要配置掃描地址，可以單獨(dú)使用，如果有多個(gè)mapper文件的話，可以在項(xiàng)目啟動(dòng)類中加入@MapperScan(“mapper文件所在包”)，這樣就不需要每個(gè)mapper文件都加@Mapper注解了
@Repository不可以單獨(dú)使用，否則會(huì)報(bào)如下錯(cuò)誤