Sohelp欢迎任何人为Hutool添砖加瓦,贡献代码,不过维护者是一个强迫症患者,为了照顾病人,需要提交的pr(pull request)符合一些规范,规范如下:
注释完备,尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息,必要时请添加单元测试。
SohelpIDE的缩进按照Eclipse(不要跟我说IDEA多好用,维护者非常懒,学不会,IDEA真香,改了Eclipse快捷键后舒服多了)默认(tab)缩进,所以请遵守(不要和我争执空格与tab的问题,这是一个病人的习惯)。
新加的方法使用第三方库的方法,必须进行备注说明。
请pull request到v5-dev分支。SohelpIDE在5.x版本后使用了新的分支:v5-master是主分支,表示已经发布中央库的版本,这个分支不允许pr,也不允许修改。
我们如果关闭了你的issue或pr,请不要诧异,这是我们保持问题处理整洁的一种方式,你依旧可以继续讨论,当有讨论结果时我们会重新打开。
- 1. 更新日志
- 2. 入门和安装
- 2.1. 简介
- 2.2. 官方网站
- 2.3. 公众号
- 3. 代码上传说明
- 3.1. 分支说明
- 3.2. 提供bug反馈或建议
- 3.3. 贡献代码的步骤
- 3.4. PR遵照的原则
- 3.5. 开发规范
- 3.5.1. SVN代码提交和修改规范
- 4. 目录结构说明
- 5. 基础工具类
- 5.1. 工具说明
- 5.2. Common工具包
- 5.2.1. 下载
- 5.2.2. 容器查询分页
- 5.2.2.1. List容器分页
- 5.2.2.2. List容器查询分页
- 5.3. Utils工具包
- 5.3.1. 下载
- 5.3.2. MD5加密
- 5.3.3. JSON解析
- 6. 数据库引擎
- 6.1. JavaDoc文档
- 6.2. 数据引擎接口
- 6.2.1. 下载
- 6.2.2. 对外接口
- 6.2.2.1. MyBatis数据接口
- 6.2.2.2. 数据库连接接口
- 6.2.2.3. 实体操作
- 6.2.2.4. 主健值操作
- 6.2.2.5. 自动编码
- 6.2.2.6 数据表日志记录
- 6.3. 数据引擎管理
- 6.3.1. 下载
- 6.3.2. 对接接口
- 7. Web引擎
- 7.1. 基础架构
- 7.2. Layui架构
- 7.2.1. Maven下载
- 7.2.2. 模块对外接口
- 7.2.3.公共接口
- 7.3. Extjs架构
- 7.3.1.Maven下载
- 7.3.2. 模块对外接口
- 7.3.3. StrutsAction说明
- 7.3.4. 公共接口
- 7.3.5 配置窗口
- 7.5. Element架构
- 7.5.1. 下载
- 7.5.2. 对外接口
- 7.5.3. VForm表单设计器
- 7.5.3.1. 保存数据
- 7.5.3.2. 获取组件对象
- 7.4. Antdv架构
- 7.4.1. 下载
- 7.4.2. 对外接口
- 8. 业务引擎
- 8.1. 通用业务引擎
- 8.1.1.Maven下载
- 8.1.2. 业务接口
- 8.1.3. 业务管理
- 8.2. MagicAPI业务引擎
- 8.2.1. 下载
- 8.2.2. 配置
- 8.2.3. 业务管理
- 8.2.4. 权限配置
- 9. 报表引擎
- 9.1. 报表基础
- 9.1.1. 下载
- 9.2. Jxls2报表
- 9.2.1. 下载
- 9.3. FastReport报表
- 9.3.1. 下载
- 9.4. UReport2报表
- 9.4.1. 下载
- 9.4.2. 对外接口
- 10. 门户引擎
- 10.1. 下载
- 11. 大屏引擎
- 11.1. 下载
- 12. 移动端引擎
- 12.1. 下载
- 13. IO引擎
- 13.1. 下载
- 14. 前端组件库
- 14.1. Element组件库
- 14.2. Antdv组件库
- 14.3. Extjs组件库
- 14.4. LayUI组件库
- 15. 开发平台
- 15.1. 下载
- 16. 业务平台
- 16.1. 业务基础平台
- 16.1.1. 下载
- 16.1.2. 第三方登录
- 16.1.2.1. 微信登录
- 16.1.2.2. QQ登录
- 16.1.2.3. 手机登录
- 16.1.3. 权限定义
- 16.1.3.1. Controller权限定义
- 16.1.3.2. Nashorn权限定义
- 16.1.3.3. MagicApi权限定义
- 16.1.4. 日志定义
- 16.1.5. 平台消息推送接口
- 16.1.5.1. 短信通知接口
- 16.1.5.2. 邮件通知接口
- 16.1.5.3. 微信公众号通知接口
- 16.1.5.4. 系统消息提醒
- 16.2. Admin LayUI平台
- 16.2.1. 下载
- 16.3. Admin Extjs平台
- 16.3.1. 下载
- 16.4. Admin Antdv平台
- 16.4.1. 下载
- 16.5. Admin Element平台
- 16.5.1. 下载
- 17. Starter配置
- 17.1. LayUI Starter配置
- 17.1.1. 下载
- 17.2. Element Starter配置
- 17.2.1. 下载
- 17.3. Antdv Starter配置
- 17.3.1. 下载
- 17.4. Extjs Starter配置
- 17.4.1. 下载
- 18. Demo平台
- 18.1. LayUI Demo平台
- 18.1.1. POM配置
- 18.1.2. 示例代码下载
- 18.1.3. 运行Jar下载
- 18.1.4. SpringBoot运行
- 18.2. Antdv Demo平台
- 18.2.1. 下载
- 18.2.2. 示例代码下载
- 18.2.3. 运行Jar下载
- 18.2.4. SpringBoot运行
- 18.3. Element Demo平台
- 18.3.1. POM配置
- 18.3.2. 示例代码下载
- 18.3.3. 运行Jar下载
- 18.3.4. SpringBoot运行
- 18.4. Extjs Demo 平台
- 18.4.1. Pom下载
- 18.4.2. 示例代码下载
- 18.4.3. 运行Jar下载
- 18.5. Uniapp Demo平台
- 18.5.1. 下载
- 18.5.2. 安装运行
- 18.5.3. 开发示例
- 19.Vform设计器