README.md 8.9 KB
Newer Older
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
1
# MyBatis JPA Extra
M
MaxKey 已提交
2 3
**MyBatis JPA Extra**对MyBatis扩展JPA功能
   
M
3.0  
MaxKey 已提交
4
1.Jakarta JPA 3注释**简化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
## 1、JPA 3注释
M
MaxKey 已提交
13

M
readme  
MaxKey 已提交
14
## 1.1、注释
M
MaxKey 已提交
15
支持9个注释
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
> * @Transient 
M
MaxKey 已提交
22 23 24
> * @Temporal
> * @ColumnDefault
> * @PartitionKey
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
25

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

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

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

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

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

MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
40
@Entity
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
41
@Table(name = "STUDENTS")  
M
MaxKey 已提交
42
public class Students extends JpaEntity implements Serializable{
M
3.0  
MaxKey 已提交
43

MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
44 45
	@Id
	@Column
M
MaxKey 已提交
46 47 48
	@GeneratedValue
	//@GeneratedValue(strategy=GenerationType.AUTO,generator="snowflakeid")
	//@GeneratedValue(strategy=GenerationType.SEQUENCE,generator="SEQ_MYBATIS_STUD")
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
49 50 51 52 53 54
	private String id;
	@Column
	private String stdNo;
	@Column
	private String stdName;
	@Column
M
MaxKey 已提交
55
	@ColumnDefault("'M'")
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
56 57 58 59 60 61 62
	private String stdGender;
	@Column
	private int stdAge;
	@Column
	private String stdMajor;
	@Column
	private String stdClass;
M
readme  
MaxKey 已提交
63 64
	@Column
	private byte[] images;
M
MaxKey 已提交
65 66 67 68
	@Column(insertable = false)
	@GeneratedValue
	@Temporal(TemporalType.TIMESTAMP)
    private LocalDateTime modifyDate;
M
3.0  
MaxKey 已提交
69
	//getter setter
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
70 71
}
```
M
readme  
MaxKey 已提交
72
## 2、基本操作
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
73

M
readme  
MaxKey 已提交
74
## 2.1、CURD
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
75 76

```java
M
MaxKey 已提交
77
	//新增数据
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
78 79 80
	@Test
	public void insert() throws Exception{
		_logger.info("insert...");
M
3.0  
MaxKey 已提交
81
		Students student = new Students();
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
82 83 84 85 86 87
		student.setStdNo("10024");
		student.setStdGender("M");
		student.setStdName("司马昭");
		student.setStdAge(20);
		student.setStdMajor("政治");
		student.setStdClass("4");
MaxKey单点登录官方's avatar
rm  
MaxKey单点登录官方 已提交
88
		service.insert(student);
M
3.0  
MaxKey 已提交
89

M
readme  
MaxKey 已提交
90 91
		Thread.sleep(1000);
		_logger.info("insert id " + student.getId());
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
92 93
	}
	
M
readme  
MaxKey 已提交
94 95 96 97
	//查询数据实体并更新
	@Test
	public void update() throws Exception{
		_logger.info("get...");
M
3.0  
MaxKey 已提交
98
		Students student = service.get("317d5eda-927c-4871-a916-472a8062df23");
M
readme  
MaxKey 已提交
99 100 101 102 103 104 105 106 107 108 109 110
		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 已提交
111
	//根据实体查询并更新
M
readme  
MaxKey 已提交
112 113 114
	@Test
	public void merge() throws Exception{
		_logger.info("merge...");
M
3.0  
MaxKey 已提交
115
		Students student = new Students();
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
116 117 118 119 120 121
		student.setStdNo("10024");
		student.setStdGender("M");
		student.setStdName("司马昭");
		student.setStdAge(20);
		student.setStdMajor("政治");
		student.setStdClass("4");
M
readme  
MaxKey 已提交
122
		service.merge(student);
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
123 124
		
		Thread.sleep(1000);
M
MaxKey 已提交
125
		_logger.info("merge id " + student.getId());
M
MaxKey 已提交
126 127
	}

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

	//查询所有记录
	@Test
	public void findAll() throws Exception{
		_logger.info("findAll...");
M
3.0  
MaxKey 已提交
150
		List<Students> listStudents = service.findAll();
M
readme  
MaxKey 已提交
151 152
	}

M
MaxKey 已提交
153
	//根据ID删除
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
154 155 156
	@Test
	public void remove() throws Exception{
		_logger.info("remove...");
M
MaxKey 已提交
157
		service.remove("921d3377-937a-4578-b1e2-92fb23b5e512");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
158 159
	}
	
M
MaxKey 已提交
160
	//根据ID集合批量删除
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
161 162 163
	@Test
	public void batchDelete() throws Exception{
		_logger.info("batchDelete...");
M
3.0  
MaxKey 已提交
164
		List<String> idList = new ArrayList<String>();
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
165 166 167 168
		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 已提交
169 170 171
		service.deleteBatch(idList);
	}
	
M
MaxKey 已提交
172
	//根据ID批量逻辑删除
M
MaxKey 已提交
173 174 175
	@Test
	public void logicDelete() throws Exception{
		_logger.info("logicDelete...");
M
3.0  
MaxKey 已提交
176
		List<String> idList = new ArrayList<String>();
M
MaxKey 已提交
177 178 179 180 181 182
		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 已提交
183 184

	//根据ID批量删除
M
MaxKey 已提交
185 186 187 188 189
	@Test
	public void batchDeleteByIds() throws Exception{
		_logger.info("batchDeleteByIds...");
		service.deleteBatch("2");
		service.deleteBatch("2,639178432667713536");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
190
	}
M
readme  
MaxKey 已提交
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
```

## 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单点登录官方 已提交
221 222 223 224
	@Test
	public void queryPageResults() throws Exception{
		_logger.info("queryPageResults...");
		 Students student=new Students();
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
225
		 student.setPageSize(10);
M
MaxKey 已提交
226 227
		 //student.setPageNumber(2);
		 student.calculate(21);
M
readme  
MaxKey 已提交
228 229 230 231 232 233
		 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单点登录官方 已提交
234
	}
M
MaxKey 已提交
235 236

	//mapper id分页查询
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
237 238 239 240 241
	@Test
	public void queryPageResultsByMapperId() throws Exception{
		_logger.info("queryPageResults by mapperId...");
		 Students student=new Students();
		 student.setStdGender("M");
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
242 243
		 student.setPageSize(10);
		 student.setPageNumber(2);
M
readme  
MaxKey 已提交
244 245
		 JpaPageResults<Students>  results =
				 service.queryPageResults("queryPageResults1",student);
M
MaxKey 已提交
246
	}
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
247 248
```

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

MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 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
```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单点登录官方 已提交
295
     <select id="queryBy" parameterType="Students" resultType="Students">
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
    	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 已提交
314
##  4、SpringBoot配置
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
315

MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
316 317 318 319 320 321 322 323
```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 已提交
324 325 326
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单点登录官方 已提交
327
mybatis.table-column-escape=true
M
readme  
MaxKey 已提交
328 329
mybatis.table-column-snowflake-datacenter-id=1
mybatis.table-column-snowflake-machine-id=1
MaxKey单点登录官方's avatar
v2.2  
MaxKey单点登录官方 已提交
330
#mybatis.table-column-escape-char=`
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
331
```
MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
332

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

M
MaxKey 已提交
334 335 336 337 338 339
##  5、相关资源

[MyBatis网站][1]

[MyBatis GitHub源码][2]

M
MaxKey 已提交
340 341 342 343
[MaxKey单点登录认证系统 GitHub源码][3]

[MaxKey单点登录认证系统 Gitee源码][4]

MaxKey单点登录官方's avatar
MaxKey单点登录官方 已提交
344 345
  [1]: http://www.mybatis.org/mybatis-3/
  [2]: https://github.com/mybatis/mybatis-3/
M
MaxKey 已提交
346 347
  [3]: https://github.com/dromara/MaxKey
  [4]: https://gitee.com/dromara/MaxKey