README.md 8.8 KB
Newer Older
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
1
# MyBatis JPA Extra
M
MaxKey 已提交
2 3
**MyBatis JPA Extra**对MyBatis扩展JPA功能
   
M
MaxKey 已提交
4
1.JPA 2.1注释**简化CUID操作**;
M
MaxKey 已提交
5
	
M
MaxKey 已提交
6
2.Interceptor实现数据库**SELECT分页查询**;
M
MaxKey 已提交
7
	
M
MaxKey 已提交
8
3.**链式**Query查询条件构造器;
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
9

M
MaxKey 已提交
10
4.提供starter,**简化SpringBoot集成**;
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
11

M
MaxKey 已提交
12 13
## 1、JPA 2.1注释

M
readme  
MaxKey 已提交
14
## 1.1、注释
M
MaxKey 已提交
15
仅支持6个注释
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
16
> * @Entity
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
17 18
> * @Table
> * @Column
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
19
> * @Id
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
20
> * @GeneratedValue
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
21 22
> * @Transient 

M
readme  
MaxKey 已提交
23
## 1.2、主键策略
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
24

M
readme  
MaxKey 已提交
25
支持3种主键策略
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
26

M
readme  
MaxKey 已提交
27 28 29 30 31
| 序号    | 策略      |   支持  |
| --------| :-----        | :----   |
| 1     | **AUTO**          | 4种主键自动填充策略<br>snowflakeid(雪花ID-推荐)<br>uuid(UUID)<br>uuid.hex(UUID十六进制)<br>serial(JPA Extra序列)   | 
| 2     | **SEQUENCE**      | 数据库序列生成,generator值为数据库序列名 | 
| 3     | **IDENTITY**      | 数据库表自增主键  |
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
32

M
readme  
MaxKey 已提交
33
## 1.3、Java Bean 注释
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
34

MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
35
```java
M
readme  
MaxKey 已提交
36

MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
37
@Entity
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
38
@Table(name = "STUDENTS")  
M
readme  
MaxKey 已提交
39
public class Students extends JpaBaseEntity implements Serializable{
MaxKey单点登录官方's avatar
README  
MaxKey单点登录官方 已提交
40
	
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
41 42
	@Id
	@Column
M
readme  
MaxKey 已提交
43
	@GeneratedValue(strategy=GenerationType.AUTO,generator="snowflakeid")
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
44
	//@GeneratedValue(strategy=GenerationType.SEQUENCE,generator="SEQ_MYBATIS_STUD")
M
readme  
MaxKey 已提交
45
	//@GeneratedValue(strategy=GenerationType.IDENTITY)
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
46
	private String id;
M
MaxKey 已提交
47
	
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
48 49
	@Column
	private String stdNo;
M
MaxKey 已提交
50
	
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
51 52
	@Column
	private String stdName;
M
MaxKey 已提交
53
	
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
54 55
	@Column
	private String stdGender;
M
MaxKey 已提交
56
	
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
57 58
	@Column
	private int stdAge;
M
MaxKey 已提交
59
	
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
60 61
	@Column
	private String stdMajor;
M
MaxKey 已提交
62
	
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
63 64 65
	@Column
	private String stdClass;
	
M
readme  
MaxKey 已提交
66 67 68
	@Column
	private byte[] images;
	
M
MaxKey 已提交
69
	public Students() {}
MaxKey单点登录官方's avatar
README  
MaxKey单点登录官方 已提交
70

M
MaxKey 已提交
71 72 73
	public get(){};
	public void set(){};
	//...
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
74 75
}
```
M
readme  
MaxKey 已提交
76
## 2、基本操作
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
77

M
readme  
MaxKey 已提交
78
## 2.1、CURD
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
79 80

```java
M
MaxKey 已提交
81
	//新增数据
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
82 83 84 85 86 87 88 89 90 91
	@Test
	public void insert() throws Exception{
		_logger.info("insert...");
		Students student=new Students();
		student.setStdNo("10024");
		student.setStdGender("M");
		student.setStdName("司马昭");
		student.setStdAge(20);
		student.setStdMajor("政治");
		student.setStdClass("4");
MaxKey单点登录官方's avatar
rm  
MaxKey单点登录官方 已提交
92
		service.insert(student);
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
93
		
M
readme  
MaxKey 已提交
94 95
		Thread.sleep(1000);
		_logger.info("insert id " + student.getId());
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
96 97
	}
	
M
readme  
MaxKey 已提交
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116

	
	//查询数据实体并更新
	@Test
	public void update() throws Exception{
		_logger.info("get...");
		Students student=service.get("317d5eda-927c-4871-a916-472a8062df23");
		System.out.println("Students "+student);
		 _logger.info("Students "+student);
		 _logger.info("update...");
		 student.setImages(null);
		 service.update(student);
		 _logger.info("updateed.");
		 
		 student.setImages("ssss".getBytes());
		 service.update(student);
		 _logger.info("updateed2.");
	}
	
M
MaxKey 已提交
117
	//根据实体查询并更新
M
readme  
MaxKey 已提交
118 119 120
	@Test
	public void merge() throws Exception{
		_logger.info("merge...");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
121
		Students student=new Students();
M
readme  
MaxKey 已提交
122
		//student.setId("10024");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
123 124 125 126 127 128
		student.setStdNo("10024");
		student.setStdGender("M");
		student.setStdName("司马昭");
		student.setStdAge(20);
		student.setStdMajor("政治");
		student.setStdClass("4");
M
readme  
MaxKey 已提交
129
		service.merge(student);
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
130 131
		
		Thread.sleep(1000);
M
MaxKey 已提交
132
		_logger.info("merge id " + student.getId());
M
MaxKey 已提交
133 134
	}

M
MaxKey 已提交
135
	//根据ID查询
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
136 137 138
	@Test
	public void get() throws Exception{
		_logger.info("get...");
M
readme  
MaxKey 已提交
139
		Students student=service.get("317d5eda-927c-4871-a916-472a8062df23");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
140 141
		System.out.println("Students "+student);
		 _logger.info("Students "+student);
M
readme  
MaxKey 已提交
142 143
	}
	
M
readme  
MaxKey 已提交
144
	//根据实体查询
M
readme  
MaxKey 已提交
145
	@Test
M
readme  
MaxKey 已提交
146 147 148 149 150 151
	public void query() throws Exception{
		_logger.info("query...");
		Students student=new Students();
		student.setStdGender("M");
		List<Students> listStudents =service.query(student);
		//...
M
readme  
MaxKey 已提交
152
	}
M
readme  
MaxKey 已提交
153 154 155 156 157 158 159 160 161

	//查询所有记录
	@Test
	public void findAll() throws Exception{
		_logger.info("findAll...");
		List<Students> listStudents =service.findAll();
		//...
	}

M
MaxKey 已提交
162
	//根据ID删除
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
163 164 165
	@Test
	public void remove() throws Exception{
		_logger.info("remove...");
M
MaxKey 已提交
166
		service.remove("921d3377-937a-4578-b1e2-92fb23b5e512");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
167 168
	}
	
M
MaxKey 已提交
169
	//根据ID集合批量删除
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
170 171 172 173 174 175 176 177
	@Test
	public void batchDelete() throws Exception{
		_logger.info("batchDelete...");
		List<String> idList=new ArrayList<String>();
		idList.add("8584804d-b5ac-45d2-9f91-4dd8e7a090a7");
		idList.add("ab7422e9-a91a-4840-9e59-9d911257c918");
		idList.add("12b6ceb8-573b-4f01-ad85-cfb24cfa007c");
		idList.add("dafd5ba4-d2e3-4656-bd42-178841e610fe");
M
MaxKey 已提交
178 179 180
		service.deleteBatch(idList);
	}
	
M
MaxKey 已提交
181
	//根据ID批量逻辑删除
M
MaxKey 已提交
182 183 184 185 186 187 188 189 190 191
	@Test
	public void logicDelete() throws Exception{
		_logger.info("logicDelete...");
		List<String> idList=new ArrayList<String>();
		idList.add("8584804d-b5ac-45d2-9f91-4dd8e7a090a7");
		idList.add("ab7422e9-a91a-4840-9e59-9d911257c918");
		idList.add("12b6ceb8-573b-4f01-ad85-cfb24cfa007c");
		idList.add("dafd5ba4-d2e3-4656-bd42-178841e610fe");
		service.logicDelete(idList);
	}
M
MaxKey 已提交
192 193

	//根据ID批量删除
M
MaxKey 已提交
194 195 196 197 198
	@Test
	public void batchDeleteByIds() throws Exception{
		_logger.info("batchDeleteByIds...");
		service.deleteBatch("2");
		service.deleteBatch("2,639178432667713536");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
199
	}
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
200

M
readme  
MaxKey 已提交
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
```

## 2.2、Find查询和Qruey构造器

```java
	//springJDBC 的查询方式
	@Test
	public void find() throws Exception{
		_logger.info("find by filter StdNo = '10024' or StdNo = '10004'");
		List<Students> listStudents = service.find(" StdNo = ? or StdNo = ?  ",
							new Object[]{"10024","10004"},
							new int[]{Types.VARCHAR,Types.INTEGER}
						);
		//...
	}

	//根据链式条件构造器查询
	//WHERE (stdMajor = '政治' and STDAGE > 30 and stdMajor in ( '政治' , '化学' )  or  ( stdname = '周瑜' or stdname = '吕蒙' ) )
	@Test
	public void filterByQuery() throws Exception{
		_logger.info("filterByQuery...");
		List<Students> listStudents = service.query(
				new Query().eq("stdMajor", "政治").and().gt("STDAGE", 30).and().in("stdMajor", new Object[]{"政治","化学"})
				.or(new Query().eq("stdname", "周瑜").or().eq("stdname", "吕蒙")));
		//...
	}
```

## 2.3、分页查询并count数据量

```java
	//根据实体分页查询
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
233 234 235 236
	@Test
	public void queryPageResults() throws Exception{
		_logger.info("queryPageResults...");
		 Students student=new Students();
M
MaxKey 已提交
237
		 //student.setStdGender("M");
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
238
		 //student.setStdMajor(政治");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
239
		 student.setPageSize(10);
M
MaxKey 已提交
240 241
		 //student.setPageNumber(2);
		 student.calculate(21);
M
readme  
MaxKey 已提交
242 243 244 245 246 247 248
		 JpaPageResults<Students>  results = service.queryPageResults(student);
		 List<Students> rowsStudents = results.getRows();
		 long records =results.getRecords();//当前页记录数量
		 long totalPage =results.getTotalPage();//总页数
		 long total =results.getTotal();//总数据量
		 long page =results.getPage();//当前页
		//...
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
249
	}
M
MaxKey 已提交
250 251

	//mapper id分页查询
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
252 253 254 255 256 257
	@Test
	public void queryPageResultsByMapperId() throws Exception{
		_logger.info("queryPageResults by mapperId...");
		 Students student=new Students();
		 student.setStdGender("M");
		 //student.setStdMajor(政治");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
258 259
		 student.setPageSize(10);
		 student.setPageNumber(2);
M
readme  
MaxKey 已提交
260 261 262
		 JpaPageResults<Students>  results =
				 service.queryPageResults("queryPageResults1",student);
		//...
M
MaxKey 已提交
263
	}
M
MaxKey 已提交
264

MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
265 266
```

M
readme  
MaxKey 已提交
267
## 3、mapper配置
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
268

MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
```xml
<mapper namespace="org.apache.mybatis.jpa.test.dao.persistence.StudentsMapper" >
	<sql id="sql_condition">
		WHERE	1	=	1
    	<if test="id != null">
			AND	ID	=	'${id}'
		</if>
		<if test="stdName != null  and stdName != '' ">
			AND STDNAME like '%${stdName}%'
		</if>
		<if test="stdGender != null  and stdGender != '' ">
			AND	STDGENDER	=	#{stdGender}
		</if>
		<if test="stdMajor != null">
			<![CDATA[AND	STDMAJOR	= #{stdMajor}]]>
		</if>
	</sql>
	
    <select id="queryPageResults" parameterType="Students" resultType="Students">
    	SELECT 
    		ID		   ,
			STDNO      ,
			STDNAME    ,
			STDGENDER  ,
			STDAGE     ,
			STDMAJOR   ,
			STDCLASS 
    	FROM STUDENTS 
    	<include refid="sql_condition"/>
    </select>
 
     <select id="queryPageResults1" parameterType="Students" resultType="Students">
    	SELECT 
    		ID		   ,
			STDNO      ,
			STDNAME    ,
			STDGENDER  ,
			STDAGE     ,
			STDMAJOR   ,
			STDCLASS 
    	FROM STUDENTS 
    	<include refid="sql_condition"/>
    </select>
       
MaxKey单点登录官方's avatar
rm  
MaxKey单点登录官方 已提交
313
     <select id="queryBy" parameterType="Students" resultType="Students">
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
    	SELECT 
    		ID		   ,
			STDNO      ,
			STDNAME    ,
			STDGENDER  ,
			STDAGE     ,
			STDMAJOR   ,
			STDCLASS 
    	FROM ROLES 
    	<include refid="sql_condition"/>
    </select>
  
    <delete id="delete" parameterType="Students" >
    	DELETE FROM STUDENTS WHERE ID=#{id}
    </delete>
    
```


M
MaxKey 已提交
333
##  4、SpringBoot配置
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
334

MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
335 336 337 338 339 340 341 342
```ini
#
spring.datasource.username=root
spring.datasource.password=maxkey
spring.datasource.url=jdbc:mysql://localhost/test?autoReconnect=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

M
readme  
MaxKey 已提交
343 344 345
mybatis.dialect=mysql
mybatis.type-aliases-package=org.apache.mybatis.jpa.test.entity
mybatis.mapper-locations=classpath*:/org/apache/mybatis/jpa/test/dao/persistence/xml/${mybatis.dialect}/*.xml
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
346
mybatis.table-column-escape=true
M
readme  
MaxKey 已提交
347 348
mybatis.table-column-snowflake-datacenter-id=1
mybatis.table-column-snowflake-machine-id=1
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
349
#mybatis.table-column-escape-char=`
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
350
```
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
351

MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
352

M
MaxKey 已提交
353 354 355 356 357 358
##  5、相关资源

[MyBatis网站][1]

[MyBatis GitHub源码][2]

MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
359 360
  [1]: http://www.mybatis.org/mybatis-3/
  [2]: https://github.com/mybatis/mybatis-3/