├── .gitignore
├── LICENSE
├── README.md
├── mapstruct-helper-core
├── .gitignore
├── pom.xml
└── src
│ ├── main
│ └── java
│ │ └── cn
│ │ └── dhbin
│ │ └── mapstruct
│ │ └── helper
│ │ └── core
│ │ ├── BeanConvertMapper.java
│ │ ├── BeanConvertMappers.java
│ │ ├── ClassKey.java
│ │ ├── Convert.java
│ │ ├── MapperConfig.java
│ │ ├── MapperDefinition.java
│ │ ├── exception
│ │ └── MapperDefinitionNotFoundException.java
│ │ └── scaner
│ │ ├── AbstractPackageMapperDefinitionScanner.java
│ │ ├── DefaultMapperDefinitionScanner.java
│ │ └── MapperDefinitionScanner.java
│ └── test
│ └── java
│ └── cn
│ └── dhbin
│ └── mapstruct
│ └── helper
│ └── core
│ ├── BeanConvertMappersTest.java
│ ├── ConvertTest.java
│ ├── bean
│ ├── BooBean.java
│ ├── FooBean.java
│ └── FooSubBean.java
│ └── mapper
│ ├── MapperDefine.java
│ ├── TestConvertMapper.java
│ └── TestConvertMapperScan.java
├── mapstruct-helper-starter
├── .gitignore
├── pom.xml
└── src
│ └── main
│ ├── java
│ └── cn
│ │ └── dhbin
│ │ └── mapstruct
│ │ └── helper
│ │ └── starter
│ │ ├── MapStructHelperAutoConfig.java
│ │ ├── MapstructInject.java
│ │ └── SpringMapperDefinitionScanner.java
│ └── resources
│ └── META-INF
│ └── spring.factories
└── pom.xml
/.gitignore:
--------------------------------------------------------------------------------
1 | ### idea ###
2 | .idea
3 | *.iml
4 |
5 | target
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # mapstruct-helper
2 |
3 | 简化mapstruct使用,灵感来源Spring Ioc。
4 |
5 | ## 使用方法
6 |
7 | ```xml
8 |
9 |
10 | cn.dhbin
11 | mapstruct-helper-core
12 | 1.0.0
13 |
14 | ```
15 |
16 | ### 例子
17 |
18 | ```java
19 | // 第一步:定义Mapper,继承cn.dhbin.mapstruct.helper.core.BeanConvertMapper
20 | @Mapper
21 | public interface FooToBooMapper extends BeanConvertMapper {
22 | }
23 |
24 | // 第二步:扫描装载Mapper(只需要配置一次)
25 | BeanConvertMappers.config(MapperConfig.defaultConfig("package").build());
26 |
27 | FooBean fooBean=new FooBean();
28 | fooBean.setName("xxx");
29 |
30 | // 使用
31 | assertEquals("xxx",BeanConvertMappers.convert(fooBean,BooBean.class).getName());
32 | assertEquals("xxx",BeanConvertMappers.convert(fooBean,new BooBean()).getName());
33 | ```
34 |
35 | ## API
36 |
37 | ### Mapper配置
38 |
39 | > cn.dhbin.mapstruct.helper.core.MapperConfig
40 |
41 | ```java
42 | BeanConvertMappers.config(
43 | MapperConfig.builder()
44 | // 是否支持待复制Bean的子类
45 | .supportSubclass(true)
46 | // mapper扫描器
47 | .mapperDefinitionScanner(new DefaultMapperDefinitionScanner("scanPackage"))
48 | // 转换方法
49 | .convertFunction((mapper,source)->{
50 | return((BeanConvertMapper)mapper).to(source);
51 | })
52 | .build()
53 | ```
54 |
55 | #### 默认配置
56 |
57 | ```java
58 | // 默认不支持待复制Bean的子类
59 | MapperConfig.defaultConfig("scanPackage").build()
60 | ```
61 |
62 | #### 扩展
63 |
64 | 默认是使用`cn.dhbin.mapstruct.helper.core.BeanConvertMapper`作为模板生成Mapper,但考虑到兼容性问题,支持自定义模板。
65 |
66 | 比如项目中原来的模板如下:
67 |
68 | ```java
69 | public interface MyBeanConvertMapper {
70 |
71 | /**
72 | * source to target
73 | *
74 | * @param source source
75 | * @return target
76 | */
77 | TARGET convert(SOURCE source);
78 |
79 | }
80 |
81 | ```
82 |
83 | 通过以下配置实现兼容:
84 |
85 | ```java
86 | BeanConvertMappers.config(MapperConfig.builder()
87 | .supportSubclass(false)
88 | .mapperDefinitionScanner(new AbstractPackageMapperDefinitionScanner("package") {
89 |
90 | @Override
91 | public Class getMapperClass() {
92 | return MyBeanConvertMapper.class;
93 | }
94 | })
95 | .convertFunction((mapper, source) -> {
96 | return ((MyBeanConvertMapper) mapper).convert(source);
97 | })
98 | .build());
99 | ```
100 |
101 | ### 转换/复制属性
102 |
103 | ```java
104 | public static T convert(Object source,Class targetClass);
105 | public static T convert(Object source,T target);
106 | ```
107 |
108 | ## 与Spring集成
109 |
110 | ### 依赖
111 |
112 | ```xml
113 |
114 | cn.dhbin
115 | mapstruct-helper-starter
116 | 1.0.0
117 |
118 | ```
119 |
120 | ### 使用
121 |
122 | ```java
123 | // 第一步:定义Mapper,继承cn.dhbin.mapstruct.helper.core.BeanConvertMapper
124 | @Mapper(componentModel = "spring")
125 | public interface FooToBooMapper extends BeanConvertMapper {
126 | }
127 |
128 |
129 | FooBean fooBean = new FooBean();
130 | fooBean.setName("xxx");
131 |
132 | // 直接使用BeanConvertMappers
133 | assertEquals("xxx",BeanConvertMappers.convert(fooBean,BooBean.class).getName());
134 | assertEquals("xxx",BeanConvertMappers.convert(fooBean,new BooBean()).getName());
135 |
136 | // 扩展:继承cn.dhbin.mapstruct.helper.core.MapperConfig注入到Ioc中
137 | ```
138 |
139 |
140 |
141 | ## LICENSE
142 |
143 | ```
144 | Copyright 2021 the original author or authors.
145 |
146 | Licensed under the Apache License, Version 2.0 (the "License");
147 | you may not use this file except in compliance with the License.
148 | You may obtain a copy of the License at
149 |
150 | http://www.apache.org/licenses/LICENSE-2.0
151 |
152 | Unless required by applicable law or agreed to in writing, software
153 | distributed under the License is distributed on an "AS IS" BASIS,
154 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
155 | See the License for the specific language governing permissions and
156 | limitations under the License.
157 | ```
158 |
159 |
160 |
161 |
162 |
163 |
--------------------------------------------------------------------------------
/mapstruct-helper-core/.gitignore:
--------------------------------------------------------------------------------
1 | ### idea ###
2 | .idea
3 | *.iml
4 |
5 | target
--------------------------------------------------------------------------------
/mapstruct-helper-core/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
18 |
19 |
22 |
23 | mapstruct-helper
24 | cn.dhbin
25 | 1.0.0
26 |
27 | 4.0.0
28 |
29 | mapstruct-helper-core
30 |
31 |
32 |
33 |
34 | org.reflections
35 | reflections
36 |
37 |
38 | cn.hutool
39 | hutool-all
40 |
41 |
42 |
43 | org.junit.jupiter
44 | junit-jupiter-engine
45 | test
46 |
47 |
48 | org.mapstruct
49 | mapstruct
50 | test
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 | org.apache.maven.plugins
59 | maven-compiler-plugin
60 | 3.8.1
61 |
62 | 1.8
63 | 1.8
64 |
65 |
66 | org.projectlombok
67 | lombok
68 | ${lombok.version}
69 |
70 |
71 | org.mapstruct
72 | mapstruct-processor
73 | ${org.mapstruct.version}
74 |
75 |
76 | org.projectlombok
77 | lombok-mapstruct-binding
78 | 0.2.0
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 |
87 |
--------------------------------------------------------------------------------
/mapstruct-helper-core/src/main/java/cn/dhbin/mapstruct/helper/core/BeanConvertMapper.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2021 the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | *
16 | */
17 |
18 | package cn.dhbin.mapstruct.helper.core;
19 |
20 | /**
21 | * @author dhbin
22 | */
23 | public interface BeanConvertMapper {
24 |
25 | /**
26 | * source to target
27 | *
28 | * @param source source
29 | * @return target
30 | */
31 | TARGET to(SOURCE source);
32 |
33 | }
34 |
--------------------------------------------------------------------------------
/mapstruct-helper-core/src/main/java/cn/dhbin/mapstruct/helper/core/BeanConvertMappers.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2021 the original author or authors.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | *
16 | */
17 |
18 | package cn.dhbin.mapstruct.helper.core;
19 |
20 | import cn.dhbin.mapstruct.helper.core.exception.MapperDefinitionNotFoundException;
21 |
22 | import java.util.Map;
23 | import java.util.function.BiFunction;
24 |
25 | /**
26 | * @author dhbin
27 | */
28 | @SuppressWarnings({"rawtypes", "unchecked"})
29 | public class BeanConvertMappers {
30 |
31 | private static Map mapperDefinitionMap;
32 |
33 | private static MapperConfig mapperConfig;
34 |
35 | private static BiFunction