# spring-data-mybatis
**Repository Path**: railswu/spring-data-mybatis
## Basic Information
- **Project Name**: spring-data-mybatis
- **Description**: Spring Data 项目的主要目标是使构建使用数据访问技术的 Spring 应用程序变得更加容易。此模块处理增强基于 MyBatis 的数据访问层的支持。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 32
- **Created**: 2017-12-04
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Spring Data MyBatis
[](https://travis-ci.org/easybest/spring-data-mybatis) [](https://gitter.im/spring-data-mybatis)
[](https://maven-badges.herokuapp.com/maven-central/io.easybest/spring-data-mybatis)
[](https://github.com/hatunet/spring-data-mybatis/blob/master/LICENSE)
[Simplified Chinese](README_zh.md)
[Documentation](https://sdm.easybest.io)
[Example Project](https://github.com/easybest/spring-data-mybatis-samples)
The primary goal of the Spring Data project is to make it easier to build Spring-powered applications that use data access technologies.
This module deals with enhanced support for MyBatis based data access layers.
## Features ##
* Implementation of CRUD methods for normal Entities
* Dynamic query generation from query method names
* Implementation domain base classes providing basic properties
* Support for transparent auditing (created, last changed)
* Possibility to integrate custom repository code
* Easy Spring integration with custom namespace
* Support MySQL, Oracle, Sql Server, H2, PostgreSQL, etc.
* Support SpringBoot 2.x
## Getting Help ##
If you have any question, please record a [issue](https://github.com/easybest/spring-data-mybatis/issues) to me.
## Quick Start ##
Download the jar through Maven:
```xml
io.easybest
spring-data-mybatis
2.0.1.RELEASE
```
The simple Spring Data Mybatis configuration with Java-Config looks like this:
```java
@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);
}
}
```
Create an entity:
```java
@Entity
@Table(name = "user")
public class User extends LongId {
@Condition
private String firstname;
@Condition(type=Condition.Type.CONTAINING) private String lastname;
private String fullName;
@Conditions({@Condition, @Condition(type=Condition.Type.CONTAINING,properties = "fuzzyName")})
private String fullName;
@Transient
private String fuzzyName;
@Column(name = "usertype")
private String status;
// Getters and setters
// (Firstname, Lastname)-constructor and noargs-constructor
// equals / hashcode
}
```
When using findAll method of MybatisRepository the @Condition or @Conditions annotations will work
Create a repository interface in `com.example.repositories`:
```java
public interface UserRepository extends MybatisRepository {
List findByLastname(String lastname);
@Query("select firstname from user")
List findUsersFirstName();
}
```
Write a test client:
```java
@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 result = repository.findByLastname("Matthews");
assertThat(result.size(), is(1));
assertThat(result, hasItem(dave));
}
}
```
## Use Spring Boot
add the jar through Maven:
```xml
io.easybest
spring-data-mybatis-boot-starter
2.0.1.RELEASE
```
If you need custom Mapper, you should add property in your application.yml like this:
```
mybatis:
mapper-locations: "classpath*:/mapper/**/**Mapper.xml"
```
And you need not to define SqlSessionFactory manually.
The full test code like this:
```java
@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 {
}
@Entity
@Table(name = "user")
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 + '\'' +
'}';
}
}
```
The full example you can find in [https://github.com/easybest/spring-data-mybatis-samples](https://github.com/easybest/spring-data-mybatis-samples)
## Contributing to Spring Data MyBatis ##
Here are some ways for you to get involved in the community:
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/forking/).
## Help me better - Donation
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=W7PLNCBK5K8JS)