spring-data-mybatis-pagination

KO | EN

gitlite — search

#python #hacktoberfest #typescript #android #linux #docker #macos #java #cli #awesome-list #pytorch #openai #mcp #ios

spring-data-mybatis-pagination

(★ 19)

Mybatis implementation for pagination interfaces defined in spring-data-commons

spring-data-mybatis-pagination Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

#### [中文](https://github.com/sea-huang/spring-data-mybatis-pagination/blob/master/README_CN.md)

# spring-data-mybatis-pagination
Support Pageable/Page/Sort/Order from spring-data-commons in Mybatis.

Auto generate and concatenate pagination sql for most database types, implemented by [PageHelper](https://github.com/pagehelper/Mybatis-PageHelper). 
 
Support full features of ordering including "direction", "ignore case" and "null handlings", refer to hibernate dialect(rewritten).

Add full features parsing for spring-data mvc-support.

Bean Adapters enhance which is more compatible for PRC serialization.

### Usage Examples
- spring-data like standard pagination, the sql in xml don't need involve pagination part, which is auto concatenated underneath.

<pre>
	Page&ltUser&gt select(@Param("name") String name, Pageable pageable);
 </pre>

- If define the result type as list. no counting sql will be executed, but only offset/limit do

<pre>
 List&ltUser&gt select(@Param("name") String name, Pageable pageable);
 </pre>

- For people who prefer @Select or @SqlProvider annotatain which don't explicitly define a result mapping strategy, Mybatis may not compatible to Page but only List results. In this cases, use ListPage<?> as the result which is a Page adapter to List.

<pre>
	@Select("SELECT * FROM T_USER")
 ListPage&ltUser&gt findPage(Pageable pageable);
	</pre>
	
- If you don't like the spring-data standard invasive style. We have a non invasive way like [PageHelper](https://github.com/pagehelper/Mybatis-PageHelper)， the result can be cast to ListPage/Page

<pre>
 SpringDataPageHelper.paginateNextCall(new PageRequest(0,4));
 List&ltUser&gt users = userMapper.findUserByName("a");
Assert.assertEquals(com.github.seahuang.spring.data.mybatis.pagination.adapter.ListPageImpl.class, users.getClass());
 </pre>
 
- Also, no-counting could be set. And in this case, result can't be cast to spring Page(you can consider it as a normal List)

<pre>
 SpringDataPageHelper.paginateNextCall(new PageRequest(0,4), false);
 users = userMapper.findUserByName("a");
 Assert.assertEquals(com.github.pagehelper.Page.class, users.getClass());
 </pre>
 
- Default Page/Pageable/Sort/Order implementation in spring-data don't support deserialization in RPC call very well. We offer a bean style version
 
 <pre>
 Pageable pageable = new PageRequest(0,4,sort);
 PageableBean pageable = PageableBean.from(pageable);
 PageBean&ltT&gt page = PageBean&ltT&gt.from(new PageImpl<T>(), pageable);
 </pre>
 
- Official mvc feature don't support "ignore case" or "null handling"
 we makeup that.
 
 <pre>
 /test?page=1&size=10&sort=AA,BB,CC,IGNORECASE|DESC|NULLS_LAST
 </pre>
 
- Setup default, it's a supplimentary to official annotations
 <pre>
 	@MoreSortDefault(value={"AA","BB"}, ignoreCase=true
		, nullHandling=NullHandling.NULLS_LAST) Pageable pageable
 </pre>
 
- A more complicated case:
 <pre>
 @MoreSortDefaults({
		@MoreSortDefault(value="AA", ignoreCase=true)
		,@MoreSortDefault(sort="BB", nullHandling=NullHandling.NULLS_LAST)
	}) @PageableDefault(sort={"AA","BB"}, direction=Direction.DESC) Pageable pageable
 </pre>
 
 
### Set up
- Add maven dependencies: PageHelper is not very stable. for 4.2.x

```xml
 <dependency>
 		<groupId>com.github.sea-huang</groupId>
 		<artifactId>spring-data-mybatis-pagination</artifactId>
 		<version>1.1.2</version>
 </dependency>
 ```	
- For pagehelper 5.1.x

```xml
 <dependency>
 		<groupId>com.github.sea-huang</groupId>
 		<artifactId>spring-data-mybatis-pagination</artifactId>
 		<version>2.1.2</version>
 </dependency>
 ```

- For spring boot app, if mybatis-spring-boot-starter(min-version 1.2.1) is on classpath. PaginationPlugin is autoconfigured
- For other cases, PaginationObjectFactory/PaginationPlugin should be manually configured

```
 <configuration>
 		<objectFactory type="com.github.seahuang.spring.data.mybatis.pagination.adapter.PaginationObjectFactory"/>
 		<plugins>
 			<plugin interceptor="com.github.seahuang.spring.data.mybatis.pagination.adapter.PaginationPlugin">
 			</plugin>
 		</plugins>
 </configuration>
 ```
 
- Or

<pre>
 @Bean
 public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource){
 	SqlSessionFactoryBean result = new SqlSessionFactoryBean();
 	result.setDataSource(dataSource);
 	result.setObjectFactory(new PaginationObjectFactory());
 	result.setPlugins(new Interceptor[]{new PaginationPlugin()});
 	return result;
 }
 </pre>
 
- To setup the enhanced mvc order parsing. we need to configure a MoreSortHandlerMethodArgumentResolver to take the place of SortHandlerMethodArgumentResolver. For boot:

<pre>
 @SpringBootApplication
 public class TestApplication extends WebMvcConfigurerAdapter {
	
 @Override
 public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
 super.addArgumentResolvers(argumentResolvers);
 MoreSortHandlerMethodArgumentResolver sortResolver = new MoreSortHandlerMethodArgumentResolver();
 argumentResolvers.add(sortResolver);
 argumentResolvers.add(new PageableHandlerMethodArgumentResolver(sortResolver));
 }
 }
 </pre>
 
- xml

```xml
 	<mvc:annotation-driven> 
	 <mvc:argument-resolvers>
			<ref bean="sortResolver"/>
	 <ref bean="pageableResolver" />
 	</mvc:argument-resolvers>
 </mvc:annotation-driven>
 <bean id="sortResolver" class="com.github.seahuang.spring.data.mybatis.pagination.mvc.MoreSortHandlerMethodArgumentResolver" />
	<bean id="pageableResolver" class="org.springframework.data.web.PageableHandlerMethodArgumentResolver">
	 <constructor-arg ref="sortResolver" />
	</bean>
 
 ```

spring-data-mybatis-pagination

spring-data-mybatis-pagination Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

spring-data-mybatis-pagination

spring-data-mybatis-pagination Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README