70 Star 564 Fork 179

sanri1993 / sanri-tools

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

9420 开发工具包

logo

star fork

sanri-tools-maven 是一个开源的用于企业开发的工具包,重点想解决项目开发中一些数据可视化,数据监控,数据调用的问题

目前已经提供一些常用的工具,读者也可以开发自己的工具 ,欢迎 pr 或者提 issue


文档

工具理念和定位

  1. 轻量级,快速启动,只依赖于文件系统,可以自行决定要不要添加权限模块
  2. 多模块,可插拨设计,只加载想要的工具
  3. 工具定位
    • 数据可视化, Redis, Kafka, Rocketmq 之类的数据明文展示
    • 数据监控, Fastdfs 的图片查看和文件下载
    • 数据调用, 可以进行无环境的数据调用, 如 Dubbo , Soap, Mybatis
    • 数据库元数据管理, 代码生成, 模板代码, 通用项目的代码生成
    • 任意无界面中间件的监控, 数据管理
  4. 本工具主要适用于开发, 不能用于监控生产数据

更新记录(代码库重要功能更新记录, 不是发行版)

更新记录

快速开始

docker启动(最新 20230328)

docker run -di -p 8084:8084 -p 10086:10086 --name=sanritools leeliang0924/sanritools:release

其它方式启动

说明: 这里只会说当前发布最新版本的运行说明, 旧版本请咨询作者

从 3.2.0 版本开始, 前端运行包(4M), 依赖包(90M), 和后端jar包(4M) 将分离, 因为之前的版本将前端包合并在后端包里无法快速修复前端 bug

大致的目录结构可以这样放置, 然后运行后端, 前端会加载 public 目录下的前端文件, 下载完整包: https://cowtransfer.com/s/54549a5602394d

sanritoolslib(依赖包)
  fastjson.jar
  connect-mysql-java.jar 
  ....
public(前端包)
  index.html
  static
sanritools.jar(后端运行包)

启动命令, 极简形式
java -Dloader.path=sanritoolslib -jar sanritools.jar

指定内存, 守护进程方式启动
nohup java -Dloader.path=sanritoolslib -Xms256m -Xmx256m -jar sanritools.jar >/dev/null 2>&1 & 

版本和文档说明

当前工具的版本在 tools-console/src/main/resources/version 文件中, 使用 3 位版本号, 主版本.次版本.bug更新

各模块版本信息和描述信息在模块的 resources/tools-[模块名].plugin.properties 中注册进来(名称,版本,作者,依赖项,帮助文档),

配置文件中帮助文档通过链接来指定, http:// 开头时为网络帮助文档, 否则在本地 resources 中查找

关于单元测试

工具使用了更方便的单元测试,直接发送 http 请求来测试,所有的单元测试都在 requests/模块名.http 文件中

如果添加了权限, 则需要这样发起请求

  1. 先调用登录请求, 它在 tools-security.http 请求里面的第一个请求
  2. 然后在请求头中添加 token 信息: Authorization: {{Authorization}}

关于项目前端

官方前端 https://gitee.com/sanri/sanritoolsvue

如果对这个前端不满意,可以使用接口进行自定义开发, 本项目只是提供数据服务, 可以通过运行 smart-doc 获取接口文档

官网前端只会支持最新版本, 不会对旧版本做兼容

首页

如何二开

详情见二开文档

如何交流、反馈、参与贡献?

  • Git仓库:https://gitee.com/sanri/sanri-tools-maven
  • 技术讨论、二次开发等咨询、问题和建议,请移步到微信群,我会在第一时间进行解答和回复
  • 如需关注项目最新动态,请Watch、Star项目,同时也是对项目最好的支持
  • 微信扫码并关注我,获得项目最新动态及更新提醒,拉你进入微信技术群
  • 如果有需要支持的中间件,可以提交 pr, 或者微信联系我

我的微信

捐赠

创作不易, 觉得工具好用的话, 可以帮打赏一下啊

支付宝微信

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.

About

sanri-tools-maven 是一个开源的用于企业开发的工具包,重点是要解决实际开发中一些数据查询,监控 ,可视化工具,目前已经聚合了 kafka,redis,zookeeper,dubbo,swagger,soap,mybatis,elasticsearch,mongodb,git , maven,rocketmq,minio 的数据查询和监控,欢迎大家使用 expand collapse
Cancel

Releases (10)

All

Contributors

All

Activities

Load More
can not load any more
Java
1
https://gitee.com/sanri/sanri-tools.git
git@gitee.com:sanri/sanri-tools.git
sanri
sanri-tools
sanri-tools
master

Search