Spring Data MyBatis基于 MyBatis 的 Spring Data 扩展
Spring Data 项目的主要目标是使构建使用数据访问技术的 Spring 应用程序变得更加容易。此模块处理增强基于 MyBatis 的数据访问层的支持。
通过使用此模块，你可以在基于MyBatis为ORM的结构下使用Spring Data模式带来的便利性。
如果你还没有接触过Spring Data，建议先了解下该项目。
支持的一些特性
-
对标准Entity支持完整CRUD操作
-
支持通过接口中的方法名生成对应的查询
-
提供基础属性的实体基类
-
支持透明审计（如创建时间、最后修改)
-
自持自定义编写基于MyBatis的查询，方便而不失灵活性
-
方便的与Spring集成
-
支持MySQL、Oracle、SQL Server、H2、PostgreSQL等数据库
获得帮助
这里有一份文档可以帮助你快速学习 Spring Data Mybatis。 reference documentation
如果你有任何疑问或者建议，可以录一个issue 给我。
快速开始
通过 Maven 引入依赖包：
<dependency> <groupId>com.ifrabbit</groupId> <artifactId>spring-data-mybatis</artifactId> <version>1.0.8.RELEASE</version> </dependency>
最简单的通过Java注解配置的Spring Data Mybatis 配置如下所示：
@Configuration
@EnableMybatisRepositories(
value = "org.springframework.data.mybatis.repository.sample",
mapperLocations = "classpath*:/org/springframework/data/mybatis/repository/sample/mappers/*Mapper.xml"
)
public class TestConfig {
@Bean
public DataSource dataSource() throws SQLException {
return new EmbeddedDatabaseBuilder().setType(EmbeddedDatabaseType.H2).addScript("classpath:/test-init.sql").build();
}
@Bean
public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource) {
SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
factoryBean.setDataSource(dataSource);
return factoryBean;
}
@Bean
public PlatformTransactionManager transactionManager(DataSource dataSource) {
return new DataSourceTransactionManager(dataSource);
}
}
创建一个实体类：
@Entity
public class User extends LongId {
private String firstname;
private String lastname;
// Getters and setters
// (Firstname, Lastname)-constructor and noargs-constructor
// equals / hashcode
}
创建一个数据操作接口,使用包名 com.example.repositories:
public interface UserRepository extends CrudRepository<User, Long> {
List<User> findByLastname(String lastname);
}
编写一个测试用例:
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = AppConfig.class)
public class UserRepositoryIntegrationTest {
@Autowired UserRepository repository;
@Test
public void sampleTestCase() {
User dave = new User("Dave", "Matthews");
dave = repository.save(dave);
User carter = new User("Carter", "Beauford");
carter = repository.save(carter);
List<User> result = repository.findByLastname("Matthews");
assertThat(result.size(), is(1));
assertThat(result, hasItem(dave));
}
}
这样就完成了。
使用 Spring Boot
通过maven引入:
<dependency> <groupId>com.ifrabbit</groupId> <artifactId>spring-boot-starter-data-mybatis</artifactId> <version>1.0.8.RELEASE</version> </dependency>
如果你需要使用自己编写的Mybatis Mapper，需要在application.properties中配置：
spring.data.mybatis.mapper-locations=classpath*:/org/springframework/data/mybatis/samples/mappers/*Mapper.xml
在Spring Boot中你不需要自己去定义SqlSessionFactory.
完整的代码如下：
@SpringBootApplication
public class SpringDataMybatisSamplesApplication {
public static void main(String[] args) {
SpringApplication.run(SpringDataMybatisSamplesApplication.class, args);
}
@Bean
public CommandLineRunner dummyCLR(ReservationRepository reservationRepository) {
return args -> {
Stream.of("Tom", "Jack", "Apple")
.forEach(name -> reservationRepository.save(new Reservation(name)));
};
}
}
@RepositoryRestResource // here we use RepositoryRestResource
interface ReservationRepository extends MybatisRepository<Reservation, Long> {
}
@Entity
class Reservation extends LongId {
private String reservationName;
public Reservation() {
}
public Reservation(String reservationName) {
this.reservationName = reservationName;
}
public String getReservationName() {
return reservationName;
}
@Override
public String toString() {
return "Reservation{" +
"reservationName='" + reservationName + '\'' +
'}';
}
}
完整的例子可以在 https://github.com/hatunet/spring-data-mybatis-samples 找到。
评论