1 Star 0 Fork 8

海涛 / spring-boot-maven-multiple-module

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

spring-boot-maven-multiple-module

用于smart-doc多模块项目文档生成测试

模块介绍

  • common(存放model类,被其它模块依赖使用)
  • dubbo-api(dubbo api接口层模块)
  • dubbo-provider(dubbo服务提供者,本项目可能不能启动,官方人员比较懒,仅做文档生成测试)
  • spring-boot-web(一个web测试模块,依赖common)
  • spring-boot-web2(一个web测试模块,依赖common)

Description

smart-doc-maven-plugin多模块测试例子,本项目严格按照父子级来构建一个项目, spring-boot-web和spring-boot-web2两个web都需要依赖common模块,因此如果是直接用mvn命令 在spring-boot-web或者spring-boot-web2都是不能直接编译项目的,要想单独编译某一个模块必须是使用 maven的pl操作才行。对于严格按照父子级构建的项目使用smart-doc-maven-plugin要单独生成某一个模块 也需要使用相同的操作,操作指令参考如下。

# 生成spring-boot-web的文档
mvn -X smart-doc:html -Dfile.encoding=UTF-8  -pl :spring-boot-web -am
# 生成spring-boot-web2的文档
mvn -X smart-doc:html -Dfile.encoding=UTF-8  -pl :spring-boot-web2 -am
# 生成spring-boot-web3的文档,web3依赖sub-module中的simple-api
mvn -X smart-doc:html -Dfile.encoding=UTF-8  -pl :spring-boot-web3 -am
# 生成spring-boot-web4的文档,web3依赖module2
mvn -X smart-doc:html -Dfile.encoding=UTF-8  -pl :spring-boot-web4 -am
# 生成sub-module中子模块web-test的文档
mvn -X smart-doc:html -Dfile.encoding=UTF-8  -pl :web-test -am
# dubbo文档生成测试
mvn -X smart-doc:rpc-html -Dfile.encoding=UTF-8  -pl :dubbo-provider -am
  • -X参数是用于生成时打印插件的日志,排查问题可以使用此参数。 生成后到各模块的static中查看文档。

从本demo测试开启debug日志发现smart-doc是完全能够支持多层级依赖查找的。当然项目需要严格按照依赖传递

Makefile编排构建

上面采用了纯mvn命令去构建了maven多模块项目(maven多模块项目是不能从子模块中直接点击smart-doc插件来生成,会导致代码扫描出现问题)。 如果习惯本地开发构建文档的同学,就需要每次输入,因此这里建议使用Makefile去制作一个maven构建的编排文件。对于windows系统环境, 需要做如下操作来支持makefile(mac系统或者linux系统都原生支持):

  • window环境下先安装MinGW
  • idea中安装Makefile Support插件

安装好环境之后即可在idea中打开makefile,然后直接选中具体的构建指令运行了。

构建日志观察

在smart-doc的多模块生成中,很多初学者会遇到很多问题,生成文档缺乏注释等。我们都知道smart-doc是依赖源码的。 一定要让smart-doc加载到源码。这里一下面这条命令的执行来说面下:

mvn -X smart-doc:html -Dfile.encoding=UTF-8  -pl :spring-boot-web -am
  • 从根目执行命令表示指定生成spring-boot-web模块的命令。
  • 执行生成该模块文档过程smart-doc会调用maven的编译,然后自动将spring-boot-web依赖的common也编译。
  • smart-doc也是利用maven api来查找依赖关系的。如果编译可以成功,则smart-doc插件就能够自动加载到common模块源代码。
[INFO] API documentation is output to src/main/resources/static/doc
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for multiple-module 1.0-SNAPSHOT:
[INFO]
[INFO] multiple-module .................................... SUCCESS [  1.133 s]
[INFO] common ............................................. SUCCESS [  1.831 s]
[INFO] spring-boot-web .................................... SUCCESS [  7.094 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  11.124 s
[INFO] Finished at: 2021-06-25T22:51:24+08:00
[INFO] ------------------------------------------------------------------------

其实从上面这个构建输出就可以发现构建生成spring-boot-web模块的过程中会自动去编译依赖的common。 因此如果你项目本身用maven命令不能自动编译依赖的模块,那说明你的项目不太符合maven父子级项目规范, common被视作独立的模块。这种情况就需要自己去处理common模块生成源码jar。否则可能无法提取注释

对于smart-doc-maven-plugin 2.2.1以前的版本如果加上-X参数,构建文档时会输出类似下面的日志。如果更高的版本则默认就会产生下面的日志。

[INFO] Smart-doc Start preparing sources at: 2021-06-26 00:20:13
[INFO] Artifacts that the current project depends on: ["org.springframework:spring-context","jakarta.annotation:jakarta.annotation-api","org.springframework:spring-core","org.spring
framework:spring-jcl","org.glassfish:jakarta.el","com.power.test:common","com.github.shalousun:common-util","com.squareup.okhttp3:okhttp","com.squareup.okio:okio"]
[INFO] Smart-doc has loaded the source code path: [{"path":"D:/workstation/spring-boot-maven-multiple-module/common//src/main/java"},{"path":"D:/workstation/
spring-boot-maven-multiple-module/spring-boot-web/src/main/java"}]
[INFO] Smart-doc Starting Create API Documentation at: 2021-06-26 00:20:15
[INFO] API documentation is output to src/main/resources/static/doc

日志中有两个重点项:

  • Artifacts that the current project depends on: 表示打印你当前构建文档的模块的pom中依赖;
  • Smart-doc has loaded the source code path: 表示smart-doc插件生成稳定中自动加载到本项目的那些源代码, 这个对于多模块项目的构建非常重要。实例中的打印就说明了构建spring-boot-web模块时插件自动加载了本项目中的common模块代码;
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

smart-doc官方maven 插件多模块使用示例 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/js_haitao/spring-boot-maven-multiple-module.git
git@gitee.com:js_haitao/spring-boot-maven-multiple-module.git
js_haitao
spring-boot-maven-multiple-module
spring-boot-maven-multiple-module
master

搜索帮助