-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathindex.html
1442 lines (1303 loc) · 53.3 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<html>
<head>
<title>dbm</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="UTF-8">
</head>
<body>
<div id='content'>
<h2 id="-dbm"># dbm</h2>
<p>基于spring jdbc实现的轻量级orm </p>
<p>项目github地址：<a href="https://github.com/wayshall/dbm"> dbm </a></p>
<p>交流群： 604158262</p>
<h2 id="目录">目录</h2>
<ul>
<li><a href="#特色">特色</a></li>
<li><a href="#示例项目">示例项目</a></li>
<li><a href="#要求">要求</a></li>
<li><a href="#maven">maven配置</a></li>
<li><a href="#一行代码启用">一行代码启用</a></li>
<li><a href="#实体映射">实体映射</a></li>
<li><a href="#id策略">id策略</a></li>
<li><a href="#复合主键映射">复合主键映射</a></li>
<li><a href="#其它特有的映射">其它特有的映射</a></li>
<li><a href="#BaseEntityManager接口和QueryDSL">BaseEntityManager接口和QueryDSL</a></li>
<li><a href="#crudentitymanager接口">CrudEntityManager接口</a></li>
<li><a href="#DbmRepository动态sql查询接口">DbmRepository动态sql查询接口</a></li>
<li><a href="#动态sql查询的语法和指令">动态sql查询的语法和指令</a></li>
<li><a href="#dbmrepository接口的多数据源支持">DbmRepository接口的多数据源支持</a></li>
<li><a href="#dbmrepository接口对其它orm框架的兼容">DbmRepository接口对其它orm框架的兼容</a></li>
<li><a href="#查询映射">查询映射</a></li>
<li><a href="#复杂的嵌套查询映射">复杂的嵌套查询映射</a></li>
<li><a href="#自定义实现dbmrepository接口">自定义实现DbmRepository接口</a></li>
<li><a href="#枚举处理">枚举处理</a></li>
<li><a href="#json映射">json映射</a></li>
<li><a href="#敏感字段映射">敏感字段映射</a></li>
<li><a href="#字段绑定">字段绑定</a></li>
<li><a href="#其它映射特性">其它映射特性</a></li>
<li><a href="#批量插入">批量插入</a></li>
<li><a href="#充血模型支持">充血模型支持</a></li>
<li><a href="#参数配置">参数配置</a></li>
<li><a href="#代码生成器">代码生成器</a></li>
</ul>
<h2 id="特色">特色</h2>
<ul>
<li><p>基本的实体增删改查（单表）不需要生成样板代码和sql文件。</p></li>
<li><p>返回结果不需要手动映射，会根据字段名称自动映射。</p></li>
<li><p>支持sql语句和接口绑定风格的DAO，但sql不是写在丑陋的xml里，而是直接写在sql文件里，这样用eclipse或者相关支持sql的编辑器打开时，就可以语法高亮，更容易阅读。</p></li>
<li><p>支持sql脚本修改后重新加载</p></li>
<li><p>内置支持分页查询。</p></li>
<li><p>接口支持批量插入</p></li>
<li><p>使用Java8新增的编译特性，不需要使用类似@Param 的注解标注参数,当然你可以显式使用注解标注参数。</p></li>
<li><p>Repository接口（用注解@DbmRepository标注了的接口）支持默认方法</p></li>
<li><p>支持多数据源绑定，可以为每个Repository接口指定具体的数据源</p></li>
<li><p>支持不同的数据库绑定，Repository接口会根据当前绑定的数据源自动绑定加载对应数据库后缀的sql文件</p></li>
<li><p>提供充血模型支持</p></li>
<li><p>支持json映射，直接把数据库的json或者varchar类型（存储内容为json数据）的列映射为Java对象</p></li>
<li><p>支持敏感字段映射</p></li>
</ul>
<h2 id="示例项目">示例项目</h2>
<p>单独使用dbm的示例项目<br />
<a href="https://github.com/wayshall/boot-dbm-sample">boot-dbm-sample</a></p>
<h2 id="要求">要求</h2>
<p>JDK 1.8+<br />
spring 4.0+</p>
<h2 id="maven">maven</h2>
<p>当前snapshot版本：4.7.4-SNAPSHOT</p>
<p>若使用snapshot版本，请添加snapshotRepository仓储：</p>
<pre><code class="xml language-xml"><repository>
<id>oss</id>
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</code></pre>
<p>添加依赖： </p>
<pre><code class="xml language-xml"><dependency>
<groupId>org.onetwo4j</groupId>
<artifactId>onetwo-dbm</artifactId>
<version>4.7.4-SNAPSHOT</version>
</dependency>
</code></pre>
<p>spring的依赖请自行添加。</p>
<h2 id="一行代码启用">一行代码启用</h2>
<p>在已配置好数据源的前提下，只需要在spring配置类（即有@Configuration注解的类）上加上注解@EnableDbm即可。<br />
```java </p>
<pre><code>@EnableDbm
@Configuration
public class SpringContextConfig {
}
</code></pre>
<pre><code>## 实体映射
</code></pre>
<p>java <br />
<a href="https://github.com/Entity">@Entity</a> <br />
<a href="https://github.com/Table">@Table</a>(name="TEST<em>USER</em>AUTOID") <br />
public class UserAutoidEntity {</p>
<pre><code>@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Column(name="ID")
protected Long id;
@Length(min=1, max=50)
protected String userName;
@Length(min=0, max=50)
@Email
protected String email;
protected String mobile;
protected UserStatus status;
//省略getter和setter
</code></pre>
<p>} </p>
<pre><code>### 注意这里用到了一些jpa的注解，含义和jpa一致：
- @Entity，表示这是一个映射到数据库表的实体
- @Table，表示这个实体映射的表
- @Id，表示这是一个主键字段
- @GeneratedValue(strategy=GenerationType.IDENTITY)，表示这个主键的值用数据库自增的方式生成，dbm目前只支持IDENTITY和SEQUENCE两种方式
- @Column，表示映射到表的字段，一般用在java的字段名和表的字段名不对应的时候
java的字段名使用驼峰的命名风格，而数据库使用下划线的风格，dbm会自动做转换
注意dbm并没有实现jpa规范，只是借用了几个jpa的注解，纯属只是为了方便。。。
后来为了证明我也不是真的很懒，也写了和@Entity、@Table、@Column对应的注解，分别是：@DbmEntity（@Entity和@Table合一），@DbmColumn。。。
- 注意：为了保持简单和轻量级，dbm的实体映射只支持单表，不支持多表级联映射。复杂的查询和映射请使用[DbmRepository接口](#dbmrepository接口)
## id策略
dbm支持jpa的GenerationType的id策略，此外还提供了通过@DbmIdGenerator自定义的策略：
- GenerationType.IDENTITY
使用数据库本身的自增策略
- GenerationType.SEQUENCE
使用数据库的序列策略（只支持oracle）
- GenerationType.TABLE
使用自定义的数据库表管理序列
- GenerationType.AUTO
目前的实现是：如果是mysql，则等同于GenerationType.IDENTITY，如果是oracle，则等同于GenerationType.SEQUENCE
- DbmIdGenerator
dbm提供id生成注解，可通过配置 generatorClass 属性，配置自定义的id实现类，实现类必须实现CustomIdGenerator接口。dbm首先会通过尝试在spring context查找generatorClass类型的bean，如果找不到则通过反射创建实例。
### 详细使用
#### GenerationType.IDENTITY
</code></pre>
<p>Java<br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="t_user")<br />
public class UserEntity implements Serializable {</p>
<pre><code>@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
protected Long id;
</code></pre>
<p>}</p>
<pre><code>#### GenerationType.TABLE
</code></pre>
<p>Java<br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="t_user")<br />
public class UserEntity implements Serializable {</p>
<pre><code>@Id
@GeneratedValue(strategy = GenerationType.TABLE, generator="tableIdGenerator")
@TableGenerator(name = "tableIdGenerator",
table="gen_ids",
pkColumnName="gen_name",
valueColumnName="gen_value",
pkColumnValue="seq_test_user",
allocationSize=50
)
protected Long id;
</code></pre>
<p>}</p>
<pre><code>#### GenerationType.SEQUENCE
</code></pre>
<p>Java<br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="t_user")<br />
public class UserEntity implements Serializable {</p>
<pre><code>@Id
@GeneratedValue(strategy=GenerationType.SEQUENCE, generator="seqGenerator")
@SequenceGenerator(name="seqGenerator", sequenceName="SEQ_TEST_USER")
protected Long id;
</code></pre>
<p>}</p>
<pre><code>### DbmIdGenerator
比如使用了dbm集成的snowflake策略，下面的配置使用了默认配置的snowflake，如果需要配置不同的datacenter和machine，建议自己实现CustomIdGenerator接口。
</code></pre>
<p>Java<br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="t_user")<br />
public class UserEntity implements Serializable {</p>
<pre><code>@Id
@GeneratedValue(strategy = GenerationType.AUTO, generator="snowflake")
@DbmIdGenerator(name="snowflake", generatorClass=SnowflakeGenerator.class)
protected Long id;
</code></pre>
<p>}</p>
<pre><code>## 复合主键映射
jpa支持三种复合主键映射策略，dbm目前只支持一种： @IdClass 映射。
映射方法如下：
假设有一个表有两个主键：id1，id2。
实体的Java代码如下：
</code></pre>
<p>Java<br />
<a href="https://github.com/Data">@Data</a><br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="composite_table")<br />
<a href="https://github.com/IdClass">@IdClass</a>(CompositeId.class)<br />
public class CompositeEntity {</p>
<pre><code>@Id
Long id1;
@Id
Long id2;
@Transient
CompositeId id;
public CompositeId getId() {
return new CompositeId(id1, id2);
}
public void setId(CompositeId id) {
this.id1 = id.getId1();
this.id2= id.getId2();
}
//....其它属性
@Data
public static class CompositeId implements Serializable {
Long id1;
Long id2;
}
</code></pre>
<p>}</p>
<pre><code>解释：
- 把需要映射为主键的实体属性都用 @Id 注解标注
- 另外创建一个复合主键的Pojo类CompositeId，属性为实体需要映射为主键的属性，名称类型一一对应，并实现 java.io.Serializable 接口
- 在实体类里用 @IdClass 注解标注为复合主键类为 CompositedId 类
- 实体的CompositeId属性不是必须的，只是为了更方便使用组合id，而且无需持久化，所以如果写的话，需要用 @Transient 注解标注
复合主键实体的查找方法为：
</code></pre>
<p>Java<br />
CompositedId cid = new CompositedId(1, 1);<br />
CompositeEntity entity = baseEntityManager.load(CompositeEntity.class, cid);</p>
<p>int deleteCount = baseEntityManager.removeById(CompositeEntity.class, entity.getId());</p>
<pre><code>## 枚举处理
### 枚举映射
dbm支持jpa的@Enumerated枚举映射注解，使用方法和jpa一样，默认为EnumType.ORDINAL int值类型映射，可以通过注解属性指定为EnumType.STRING名称映射。
但是，当枚举为EnumType.ORDINAL映射的时候，ordinal的值是从0开始根据定义时的先后顺序决定，这使得我们开发的时候很不方便，比如我有一个枚举类型，是需要映射为int类型，但是值并不是从0开始的，这时候就相当的尴尬，因为你既不能用默认为EnumType.ORDINAL,也不能用EnumType.STRING。
所以dbm还另外增加了自定义的int值映射接口DbmEnumValueMapping，只要枚举类型实现了这个接口，就可以自定义返回实际的映射值，比如：
</code></pre>
<p>Java<br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="TEST_USER")<br />
public class UserEntity {<br />
<a href="https://github.com/Id">@Id</a><br />
Long id;<br />
<a href="https://github.com/Enumerated">@Enumerated</a>(EnumType.ORDINAL)<br />
UserGenders gender;</p>
<pre><code>public static enum UserGenders {
FEMALE("女性"),
MALE("男性");
final private String label;
private UserGenders(String label) {
this.label = label;
}
public String getLabel() {
return label;
}
}
</code></pre>
<p>}</p>
<pre><code>如果按照jpa的做法，枚举类型映射为@Enumerated(EnumType.ORDINAL)后，用户实体的gender属性对应的数据库列只能是0（FEMALE）和1（MALE）。
在dbm里，你可以通过实现DbmEnumValueMapping接口，返回自定义的映射值，比如10（FEMALE）和11（MALE）。
</code></pre>
<p>Java<br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="TEST_USER")<br />
public class UserEntity {<br />
<a href="https://github.com/Id">@Id</a><br />
Long id;<br />
<a href="https://github.com/Enumerated">@Enumerated</a>(EnumType.ORDINAL)<br />
UserGenders gender;</p>
<pre><code>public static enum UserGenders implements DbmEnumValueMapping {
FEMALE("女性", 10),
MALE("男性", 11);
final private String label;
final private int value;
private UserGenders(String label, int value) {
this.label = label;
this.value = value;
}
public String getLabel() {
return label;
}
@Override
public int getMappingValue() {
return value;
}
}
</code></pre>
<p>}</p>
<pre><code>### 枚举属性查询时的处理
- 如果枚举实现了 DbmEnumValueMapping 接口，则取DbmEnumValueMapping#getMappingValue()方法所得的值
- 通过Querys 和 BaseEntityManager 的api查询时，一般直接取枚举的name()方法所得的值
- 如果是@DbmRepository 接口，并且用@Param注解指定了enumType属性，则根据配置的取相应的值，但是DbmEnumValueMapping接口优先级更高
## json映射
有时候，我们需要在数据库的某个字段里存储json格式的数据，又想在获取到数据后转为java对象使用，这时你可以使用 @DbmJsonField 注解，这个注解会在保存实体的时候把对象转化为json字符串，然后在取出数据的时候自动把字符串转化为对象。
示例：
</code></pre>
<p>Java<br />
class SimpleEntity {<br />
<a href="https://github.com/DbmJsonField">@DbmJsonField</a><br />
private ExtInfo extInfo;</p>
<pre><code>public static class ExtInfo {
String address;
List<String> phones;
}
</code></pre>
<p>}</p>
<pre><code>如果该字段是泛型，需要保存类型信息，可以设置storeTyping属性为true
</code></pre>
<p>Java<br />
class SimpleEntity {<br />
<a href="https://github.com/DbmJsonField">@DbmJsonField</a>(storeTyping=true)<br />
private Map<String, ConfigData> configData;</p>
<pre><code>public static class ExtInfo {
String address;
List<String> phones;
}
</code></pre>
<p>}</p>
<pre><code>需要添加依赖：
</code></pre>
<p>xml<br />
<dependency>
<groupId>org.onetwo4j</groupId>
<artifactId>onetwo-jackson</artifactId>
</dependency></p>
<pre><code>## 敏感字段映射
### 加解密映射
对于一些不适宜明文存储的字段信息，比如api密钥，存储的时候自动加密，获取的时候自动解密，此时可以使用@DbmEncryptField 注解。
</code></pre>
<p>Java<br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="TEST_MERCHANT")<br />
public class MerchantEntity implements Serializable {</p>
<pre><code>@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Column(name="ID")
protected Long id;
@DbmEncryptField
protected String apikey;
</code></pre>
<p>}</p>
<pre><code>在@DbmRepository 使用这个功能时，可以在插入的参数后面加上后缀函数：
</code></pre>
<p>sql<br />
/<strong>*</strong></p>
<ul>
<li><a href="https://github.com/name">@name</a>: batchInsert</li>
<li>批量插入 */<br />
insert <br />
into<br />
test_merchant<br />
(id, apikey) <br />
values<br />
(:id, :apikey?encrypt)</li>
</ul>
<pre><code>**注意**
- dbm的敏感字段加密功能依赖jasypt
- 你可以通过下面属性配置jasypt的StandardPBEStringEncryptor
</code></pre>
<p>yaml<br />
dbm: <br />
encrypt: <br />
algorithm: PBEWithMD5AndTripleDES #默认加密算法<br />
password: test #密钥</p>
<pre><code>### 脱敏映射
对于另一些字段，我们可能并不需要加解密，而只是在存储或者获取的时候，按照一定的规则脱敏。比如手机号码取出的时候自动对后面四位打上星号，或者邮件地址只显示第一个字符和@后面的字符，则可以使用 @DbmSensitiveField 注解进行脱敏映射。
</code></pre>
<p>Java<br />
<a href="https://github.com/Entity">@Entity</a><br />
<a href="https://github.com/Table">@Table</a>(name="TEST_USER")<br />
public class UserEntity implements Serializable {</p>
<pre><code>@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Column(name="ID")
private Long id;
private String mobile;
@DbmBindValueToField(name="mobile") //查询实体时，此字段的值来自mobile字段
@Transient //此字段无需保存到数据库
@DbmSensitiveField(leftPlainTextSize=7, on=SensitiveOns.SELECT)
// 保留手机号码只显示左边7位，如13612345678，取出脱敏后mobile的值为：1361234****
private String mobileUnsensitive;
@DbmSensitiveField(leftPlainTextSize=1, sensitiveIndexOf="@", on=SensitiveOns.SELECT)
// 邮件地址左边保留一个长度的字符，@后面的字符都保留，其余用星号代替，如[email protected]，取出脱敏后为：t***@gmail.com
private String email;
</code></pre>
<p>}</p>
<pre><code>**解释**
DbmSensitiveField 属性解释如下：
- on: 表示进行脱敏的时机，有两个选择：STORE（保存到数据库的时候），SELECT（从数据库获取出来转换为java对象的时候）
- leftPlainTextSize: 脱敏时需要左边保持明文的字符长度
- rightPlainTextSize: 脱敏时需要右边保持明文的字符长度
- sensitiveIndexOf: 当不想整个字段进行脱敏的时候，此属性表示某个指定的字符索引作为脱敏的结束索引。比如邮件脱敏，@字符后面的保留时，此属性值可以写为"@"
- replacementString: 替换敏感数据的字符串，默认为星号
**注意**
此功能从 4.7.4 版本开始支持
### 字段绑定
@DbmBindValueToField 注解可以帮某个字段的值绑定到另一个字段，绑定后，实体查询时，此字段的值将会取自绑定的值。例子可以参考 [脱敏映射](#脱敏映射)
**注意**
此功能从 4.7.4 版本开始支持
## 其它特有的映射
### @DbmField注解
@DbmField 注解可自定义一个值转换器，用于从数据库表获取的字段值转换为Java对象的属性值，和把Java对象的属性值转换为数据库表的字段值。
@DbmJsonField 注解实际上是包装了@DbmField注解实现的。
## BaseEntityManager接口和QueryDSL
大多数数据库操作都可以通过BaseEntityManager接口来完成。
BaseEntityManager可直接注入。
先来个简单的使用例子：
</code></pre>
<p>java </p>
<pre><code>@Resource
private BaseEntityManager entityManager;
@Test
public void testSample(){
UserAutoidEntity user = new UserAutoidEntity();
user.setUserName("dbm");
user.setMobile("1333333333");
user.setEmail("[email protected]");
user.setStatus(UserStatus.NORMAL);
//save
Long userId = entityManager.save(user).getId();
assertThat(userId, notNullValue());
//update
String newMobile = "13555555555";
user.setMobile(newMobile);
entityManager.update(user);
//fetch by id
user = entityManager.findById(UserEntity.class, userId);
assertThat(user.getMobile(), is(newMobile));
//通过实体属性查找，下面的调用相当于sql条件： where mobile='13555555555' and status IN ('NORMAL', 'DELETE') and age>18
user = entityManager.findOne(UserAutoidEntity.class,
"mobile", newMobile,
"status:in", Arrays.asList(UserStatus.NORMAL, UserStatus.DELETE),
"age:>", 18);
assertThat(user.getId(), is(userId));
//下面的调用相当于sql条件： where registerTime>=:date1 and registerTime<:date2
entityManager.findList(UserEntity.class, "registerTime:date in", new Object[]{date1, date2})
}
</code></pre>
<pre><code>BaseEntityManager对象的find开头的接口，可变参数一般都是按键值对传入，相当于一个Map，键是实体对应的属性(+冒号+操作符，可选，不加默认就是=)，值是对应属性的条件值：
</code></pre>
<p>Java<br />
entityManager.findOne(entityClass, propertyName1, value1, propertyName2, value2……); <br />
entityManager.findList(entityClass, propertyName1, value1, propertyName2, value2……);</p>
<pre><code>key，value形式的参数最终会被and操作符连接起来。
其中属性名和值都可以传入数组或者List类型的参数，这些多值参数最终会被or操作符连接起来，比如：
- 属性名参数传入一个数组：
</code></pre>
<p>Java <br />
entityManager.findList(entityClass, new String[]{propertyName1, propertyName2}, value1, propertyName3, value3);</p>
<pre><code>最终生成的sql语句大概是：
</code></pre>
<p>sql<br />
select t.* from table t where (t.property<em>name1=:value1 or t.property</em>name2=:value1) and t.property_name3=:value3</p>
<pre><code>- 属性值参数传入一个数组：
</code></pre>
<p>Java <br />
entityManager.findList(entityClass, propertyName1, new Object[]{value1, value2}, propertyName3, value3);</p>
<pre><code>最终生成的sql语句大概是：
</code></pre>
<p>sql<br />
select t.* from table t where (t.property<em>name1=:value1 or t.property</em>name1=:value2) and t.property_name3=:value3</p>
<pre><code>- find 风格的api会对一些特殊参数做特殊的处理，比如 K.IF_NULL 属性是告诉dbm当查询值查找的属性对应的值为null或者空时，该如何处理，IfNull.Ignore表示忽略这个条件。 **
比如：
</code></pre>
<p>Java <br />
entityManager.findList(entityClass, propertyName1, new Object[]{value1, value2}, propertyName3, value3, K.IF_NULL, IfNull.Ignore);</p>
<pre><code>那么，当value3（或者任何一个属性对应的值）为nul时，最终生成的sql语句大概是：
</code></pre>
<p>sql<br />
select t.* from table t where (t.property<em>name1=:value1 or t.property</em>name1=:value2) </p>
<pre><code>property_name3条件被忽略了。
### 操作符
BaseEntityManager的属性查询支持如下操作符：
=, >, <, !=, in, not in, date in, is null, like, not like
### Query DSL API
dbm还提供了一个专门用于构建查询的dsl api
</code></pre>
<p>Java</p>
<p>//使用 querys dsl api<br />
UserAutoidEntity queryUser = Querys.from(entityManager, UserAutoidEntity.class)<br />
.where()<br />
.field("mobile").is(newMobile)<br />
.field("status").is(UserStatus.NORMAL)<br />
.end()<br />
.toQuery()<br />
.one();<br />
assertThat(queryUser, is(user));</p>
<pre><code>注意：
4.7.3后，query dsl api 已集成到 BaseEntityManager 接口，可以通过 BaseEntityManager 直接创建查询：
</code></pre>
<p>Java<br />
public Optional<User> findBy(String month, Long userId) {<br />
return baseEntityManager.from(User.class)<br />
.where()<br />
.field("month").is(month)<br />
.field("userId").is(userId)<br />
.toQuery()<br />
.optionalOne();<br />
}</p>
<pre><code>通过链式api和Java8 的 Stream api，你可以创建出这样的查询代码：
</code></pre>
<p>Java<br />
public List<User> findList(String month, Long userId) {<br />
return baseEntityManager.from(DuesDetailEntity.class)<br />
.where()<br />
.field("duesMonth").is(month)<br />
.field("userId").is(userId)<br />
.toQuery()<br />
.list()<br />
.stream()<br />
.map(user -> user.asBean(UserVO.class)) //把实体转换为VO<br />
.collect(Collectors.toList());<br />
}</p>
<pre><code>动态条件和or 查询：
</code></pre>
<p>Java<br />
// 下面代码生成的sql条件：(age = 12 and userName like %test%) or (email like %qq.com and mobile=136666666) <br />
public Optional<User> findBy(String month, Long userId) {<br />
return baseEntityManager.from(User.class)<br />
.where()<br />
.field("age").is(12)<br />
.field("userName").when(()->userName!=null).like(userName) // userName不为null的时候，userName条件才会被生成<br />
.or()<br />
.field("email").prelike("qq.com")<br />
.field("mobile").is("13666666666")<br />
.toQuery()<br />
.optionalOne();<br />
}</p>
<pre><code>## CrudEntityManager接口
CrudEntityManager是在BaseEntityManager基础上封装crud的接口，是给喜欢简单快捷的人使用的。
CrudEntityManager实例可在数据源已配置的情况下通过简单的方法获取：
</code></pre>
<p>java <br />
<a href="https://github.com/Entity">@Entity</a> <br />
<a href="https://github.com/Table">@Table</a>(name="TEST<em>USER</em>AUTOID") <br />
public class UserAutoidEntity {</p>
<pre><code>final static public CrudEntityManager<UserAutoidEntity, Long> crudManager = Dbms.obtainCrudManager(UserAutoidEntity.class);
@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
@Column(name="ID")
protected Long id;
@Length(min=1, max=50)
protected String userName;
//省略getter和setter
</code></pre>
<p>} </p>
<pre><code>然后通过静态变量直接访问crud接口：
</code></pre>
<p>Java </p>
<pre><code>UserAutoidEntity.crudManager.save(entity);
UserAutoidEntity user = UserAutoidEntity.crudManager.findOne("userName", userName);
</code></pre>
<pre><code>## DbmRepository动态sql查询接口
DbmRepository接口支持类似mybatis的sql语句与接口绑定，但sql文件不是写在丑陋的xml里，而是直接写在sql文件里，这样用eclipse或者相关支持sql的编辑器打开时，就可以语法高亮，更容易阅读。
### 1、定义一个接口
包名：test.dao
</code></pre>
<p>java <br />
<a href="https://github.com/DbmRepository">@DbmRepository</a><br />
public interface UserAutoidDao {</p>
<pre><code>@ExecuteUpdate
public int removeByUserName(String userName);
</code></pre>
<p>}</p>
<pre><code>### 2、定义一个.jfish.sql文件
在resource源码代码文件下新建一个目录：sql
然后在sql目录里新建一个UserAutoidDao全类名的.jfish.sql文件，完整路径和文件为：
sql/test.dao.UserAutoidDao.jfish.sql
文件内容为：
</code></pre>
<p>sql<br />
/<strong>*</strong></p>
<ul>
<li><a href="https://github.com/name">@name</a>: removeByUserName</li>
<li>批量删除<br />
*/<br />
delete from test<em>user</em>autoid <br />
where 1=1 <br />
---这里的userName变量就是接口里的userName参数<br />
[#if userName?has<em>content]
---这里的userName命名查询参数也是接口里的userName参数
and user</em>name like :userName<br />
[/#if]</li>
</ul>
<pre><code>解释：
- dbm会根据sql文件名去掉.jfish.sql后缀后作为类名，绑定对应的接口类，此处为：test.dao.UserAutoidDao
- @name: 表示此sql绑定的方法，此处表示会绑定到UserAutoidDao.removeByUserName方法
- \[\#if\]...\[/\#if\]，是freemarker的语法，表示条件判断。此处表示，如果userName的值不为空，才生成“user_name like ？” 这个条件
- :userName，spring jdbc的命名参数，和接口的方法参数绑定
- @ExecuteUpdate注解表示这个方法会以jdbc的executeUpdate方法执行，实际上可以忽略，因为dbm会识别update，insert，delete等前缀的方法名来判断。
### 3、调用
</code></pre>
<p>java</p>
<p><a href="https://github.com/Service">@Service</a> <br />
<a href="https://github.com/Transactional">@Transactional</a> <br />
public class UserAutoidServiceImpl {</p>
<pre><code>@Resource
private UserAutoidDao userAutoidDao;
public int removeByUserName(){
return this.userAutoidDao.removeByUserName("%userName%");
}
</code></pre>
<p>}</p>
<pre><code>`
提示：如果你不想传入 "%userName%"，可以把sql文件里的命名参数“:userName”改成“:userName?likeString”试试，后面的?likeString是调用dbm内置的likeString方法，该方法会自动在传入的参数前后加上'%'。
`
`
注意：从4.7.3开始，dbm的 DbmRepository接口 支持Java8接口默认方法。
`
### 通过@Query直接在代码里写sql
虽然本人不喜欢不推荐在代码里写sql，但实际开发中经常遇到很多人都是喜欢简单粗暴，直接在代码里通过注解写sql，所以，新版（4.5.2-SNAPSHOT+）的dbm提供了@Query来支持在代码里写sql。
使用示例：
</code></pre>
<p>Java<br />
<a href="https://github.com/DbmRepository">@DbmRepository</a> //标记这是一个dbm的Repository接口<br />
public interface UserDao {</p>
<pre><code>@Query("insert into test_user (id, email, gender, mobile, nick_name, password, status, user_name) "
+ " values (:id, :email, :gender, :mobile, :nickName, :password, :status, :userName)")
int batchSaveUsers(List<UserEntity> users);
@Query(value="select t.* from test_user t where 1=1 "
+ "[#if userName?has_content] "
+ "and t.user_name like :userName?likeString "
+ "[/#if]")
Page<UserEntity> findUserPage(Page<UserEntity> page, String userName);
</code></pre>
<p>}</p>
<pre><code>## 动态sql查询的语法和指令
### 常用指令
sql模板使用的实际上是freemarker模板引擎，因此freemarker支持的语法都可以使用。
一般比较常用到的指令如下：
- if 指令
</code></pre>
<p>sql<br />
[#if 条件表达式]<br />
……<br />
[/#if]</p>
<pre><code>- list 迭代指令
</code></pre>
<p>sql<br />
[#list 可迭代的变量 as item]<br />
……t.column_name = ${item.property1}<br />
[/#list]</p>
<pre><code>条件表达式除了通常的逻辑判断外，还有一些比较常用到的表达式：
- 变量??,双问号，用于判断一个变量是否存在
- 变量?has_content，用于判断变量是有内容，比如字符串的话，相等于判断是否为空。
### dbm扩展指令
另外增加了一些特定的指令以帮助处理sql，包括：
- @foreach
- @str
- @where
- @set
- @dateRange
#### foreach指令
foreach 遍历指令
可以在sql，循环可遍历的参数，并用joiner连接起来，比如当传入ids是个列表，我们需要在sql进入in查询时：
</code></pre>
<p>sql<br />
/***</p>
<ul>
<li><a href="https://github.com/name">@name</a>: findPermissions</li>
<li><a href="https://github.com/parser">@parser</a>: template</li>
<li><br />
<em>/
select
t.</em><br />
from <br />
data t<br />
[#if ids??]<br />
where<br />
t.id in (<br />
[@foreach list=ids joiner=', '; id, index]<br />
#{id}<br />
[/@foreach]<br />
)<br />
[/#if]</li>
</ul>
<pre><code>- list 属性：可遍历的参数
- joiner 属性：连接字符
- id：遍历的时候，引用每个正在遍历的元素的变量名
- index：当前遍历的索引
当然，这里只是为了演示foreach指令的用法，实际上，dbm的sql参数可以直接支持list参数类型，当传入的参数是个列表的时候，会自动分解参数。
上面的语句实际上可直接写成：
</code></pre>
<p>sql<br />
select <br />
t.*<br />
from <br />
data t<br />
[#if ids??]<br />
where<br />
t.id in ( :ids )<br />
[/#if]</p>
<pre><code>#### str指令
@str 字符串指令
可以在sql动态生成条件查询时，自动插入指定字符，同时去掉头尾多余的字符，比如动态插入where和去掉多余的and或者or：
</code></pre>
<p>sql<br />
/****</p>
<ul>
<li><a href="https://github.com/name">@name</a>: findUsers<br />
*/<br />
select<br />
*<br />
from<br />
TEST<em>USER u
[@str insertPrefix='where' trimPrefixs='and | or' trimSuffixs='and | or']
[#if query.userName?has</em>content]<br />
u.user_name = :query.userName<br />
[/#if]<br />
[#if query.age??]<br />
and u.age = :query.age<br />
[/#if]<br />
[#if query.status??]<br />
and u.status = :query.status or <br />
[/#if]<br />
[/@str]</li>
</ul>
<pre><code>- insertPrefix 属性：当指令里面的sql条件不为空的时候，会自动把insertPrefix属性的字符串插入，这里就是where
- trimPrefixs 属性：如果生成的sql片段以trimPrefixs指定的单词开始时，则会自动被去掉。支持指定多个单词，|为分隔符。
- trimSuffixs 属性：如果生成的sql片段以trimSuffixs指定的单词结束时，则会自动被去掉。支持指定多个单词，|为分隔符。
### where指令
where指令可以在sql动态生成条件查询时，自动加上where，或者去掉多余的and或者or关键字，它是@str指令的包装。
@str指令一节里的sql可以用where指令写成这样：
</code></pre>
<p>sql<br />
/****</p>
<ul>
<li><a href="https://github.com/name">@name</a>: findUsersWithWhere<br />
*/<br />
select<br />
*<br />
from<br />
TEST<em>USER u
[@where]
[#if query.userName?has</em>content]<br />
u.user_name = :query.userName<br />
[/#if]<br />
[#if query.age??]<br />
and u.age = :query.age<br />
[/#if]<br />
[#if query.status??]<br />
and u.status = :query.status or <br />
[/#if]<br />
[/@where]</li>
</ul>
<pre><code>### set指令
set 指令与where指令类似，只是@str指令的包装，用于sql更新语句：
</code></pre>
<p>sql<br />
/***</p>
<ul>
<li><a href="https://github.com/name">@name</a>: updateUsersWithSet<br />
*/<br />
update<br />
TEST<em>USER
[@set]
[#if query.userName?has</em>content]<br />
user_name = :query.userName, <br />
[/#if]<br />
[#if query.age??]<br />
age = :query.age, <br />
[/#if]<br />
[#if query.status??]<br />
status = :query.status,<br />
[/#if]<br />
[/@set]<br />
where <br />
id = :query.id</li>
</ul>
<pre><code>### 其他特性
- 支持通过特殊的注解参数进行查询分派：
</code></pre>
<p>Java<br />
<a href="https://github.com/DbmRepository">@DbmRepository</a><br />
public interface UserDao {</p>
<pre><code>public List<UserVO> findUserList(@QueryDispatcher String type);
</code></pre>
<p>}</p>
<pre><code>dbm会根据QueryDispatcher注解标记的特殊参数的值，分派到不同的sql。
如果type==inner时，那么这个查询会被分派到findUserList(inner)；
如果type==outer时，那么这个查询会被分派到findUserList(inner)
sql文件：
</code></pre>
<p>sql<br />
/***</p>
<ul>
<li><a href="https://github.com/name">@name</a>: findUserList(inner)<br />
<em>/
select
usr.</em><br />
from <br />
inner_user usr</li>
</ul>
<p>/***</p>
<ul>
<li><a href="https://github.com/name">@name</a>: findUserList(outer)<br />
<em>/
select
usr.</em><br />
from <br />
outer_user usr</li>
</ul>
<pre><code>- in条件可以传入 Collection 类型的值，会自动解释为多个in参数
DbmRepository接口：
</code></pre>
<p>Java<br />
<a href="https://github.com/DbmRepository">@DbmRepository</a><br />
public interface UserDao {</p>
<pre><code>public List<UserVO> findUser(List<String> userNames);
</code></pre>
<p>}</p>
<pre><code>sql文件：
</code></pre>
<p>sql<br />
/***</p>
<ul>
<li><a href="https://github.com/name">@name</a>: findUser<br />
<em>/
select
usr.</em><br />
from <br />
t<em>user usr
where
usr.user</em>name in ( :userNames )</li>
</ul>
<pre><code>注意：必须是Collection类型，不支持数组类型。
- dbm默认会注入一些辅助函数以便在sql文件中调用，可通过_func前缀引用，比如${_func.dateAs(date, "yyyy-MM-dd")}格式化日期。通过QueryConfig注解扩展在sql文件使用的辅助函数集。
sql文件：
</code></pre>
<p>sql<br />
/***</p>
<ul>
<li><a href="https://github.com/name">@name</a>:</li>
<li>findUser<br />
<em>/
select
usr.</em><br />
from <br />
t<em>user usr
where
usr.birthday=${</em>func.dateAs(date, "yyyy-MM-dd")}</li>
</ul>
<pre><code>- 支持Optional类型的返回值
## DbmRepository接口的多数据源支持
DbmRepository 查询接口还可以通过注解支持绑定不同的数据源，dataSource的值为spring bean的名称：
</code></pre>
<p>Java<br />
<a href="https://github.com/DbmRepository">@DbmRepository</a>(dataSource="dataSourceName1")<br />
public interface Datasource1Dao {<br />
}</p>
<p><a href="https://github.com/DbmRepository">@DbmRepository</a>(dataSource="dataSourceName2")<br />
public interface Datasource2Dao {<br />
}</p>
<pre><code>## DbmRepository接口对其它orm框架的兼容
DbmRepository 的查询接口是可以独立于dbm使用的，其它orm框架可以通过实现QueryProvideManager接口，然后通过 @DbmRepository 注解的queryProviderName或queryProviderClass属性指定特定的QueryProvideManager实现类。从而让DbmRepository查询接口使用其它orm框架，避免不同orm框架共存带来的一些副作用。
dbm内置了JPA（Hibernate）实现的QueryProvideManager。
但一个一个地把DbmRepository接口设置成相同的实现的QueryProvideManager实现的是不明智，只是没有意义的重复劳动，所以dbm另外提供了@EnableDbmRepository注解，单独激活和配置DbmRepository默认的QueryProvideManager。
</code></pre>
<p>Java<br />
<a href="https://github.com/EnableDbmRepository">@EnableDbmRepository</a>(value="org.onetwo.common.hibernate.dao", <br />
defaultQueryProviderClass=HibernateJPAQueryProvideManager.class,<br />
autoRegister=true)<br />
public static class HibernateTestConfig {<br />
}</p>
<pre><code>## 查询映射
DbmRepository的查询映射无需任何xml配置，只需要遵循规则即可：
- 1、 Java类的属性名与sql查询返回的列名一致(不区分大小写)
- 2、 或者Java类的属性名采用驼峰命名，而列明采用下划线的方式分隔。如：userName对应user_name
默认的映射规则实际上和使用了@DbmRowMapper注解下的SMART_PROPERTY模式一致。
详见：[注解@DbmRowMapper](#注解dbmrowmapper)
举例：
### 创建一个DbmRepository接口
</code></pre>
<p>Java</p>
<p><a href="https://github.com/DbmRepository">@DbmRepository</a><br />
public interface CompanyDao {<br />
List<CompanyVO> findCompaniesByLikeName(String name);<br />
List<CompanyVO> findCompaniesByNames(Collection<String> names);<br />
}</p>
<p>public class CompanyVO {<br />
protected Long id;<br />
protected String name;<br />
protected String description;<br />
protected int employeeNumber;</p>
<pre><code>//省略getter和setter
</code></pre>
<p>}</p>
<pre><code>### 对应的sql文件CompanyDao.jfish.sql
内容如下：
</code></pre>
<p>sql<br />
/****</p>
<ul>
<li><a href="https://github.com/name">@name</a>: findCompaniesByLikeName<br />
*/<br />
select <br />
comp.id,<br />
comp.name,<br />
comp.description,<br />
comp.employee_number<br />
from<br />
company comp<br />
where<br />
comp.name like :name?likeString</li>
</ul>
<p>/****</p>
<ul>