1 Star 1 Fork 0

Linitly / linitly-boot

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

linitly-boot

本项目是基于SpringBoot2.3、JWT、MyBatis、Redis集成一些常用功能的脚手架,旨在简化日常开发。

当前最新版本:1.3.0

技术架构

开发环境

  • 开发语言:JAVA 1.8
  • IDE:IDEA+Lombok插件
  • 项目管理:Maven
  • 数据库:MySQL5.7+
  • 缓存数据库:Redis

后端框架

  • 基础框架:SpringBoot 2.3.12.RELEASE
  • 持久层框架:mybatis、pageHelper
  • 缓存:redis
  • 数据库连接池:druid
  • 文档框架:swagger
  • 安全:JWT
  • 定时任务:quartz
  • 其它:谷歌guava、fastjson、lombok、poi、httpclient

项目结构

后端

- base	系统提供基础功能模块
	- annotation  系统注解
	- aop  系统切面功能模块
	- config  系统配置文件
	- constant  系统常量文件
	- controller  系统控制层文件
	- dao  系统dao层
	- dto  系统dto文件
	- entity  系统数据库映射实体类
	- enums  系统枚举
	- exception 系统异常
	- filter  系统过滤器
	- handle  系统处理功能
	- helper  系统帮助模块
	- interceptor  系统拦截器
	- service  系统业务层文件
    - utils  系统工具类
    - vo  系统vo文件
- business	开发者业务模块(预留)
	- constant  业务常量文件
	- controller  业务控制层文件
	- dao  业务dao层
	- dto  业务dto文件
	- entity  业务数据库映射实体类
	- service  业务逻辑层文件
	- vo  业务vo文件

前端对接说明

数据

统一返回数据格式(一级)如下:

{
    "code": 200,							// 状态码,需先判断
    "message": "成功",					   // 提示信息,状态码非正常情况,除特殊情况,可直接提取该信息
    "data": null,							// 返回业务数据
    "specialData": null,					// 特殊数据,一般用不到,特殊情况用到特别说明
    "timestamp": 1607485350802				// 时间戳,仅供参考,不用处理
}

前端需首先判断code状态码,200为业务处理正常,其它为异常情况;

目前412417状态码需提示后,跳转到登陆页面;其它情况可直接提取提示信息。

返回数据说明

返回数据一般分以下几种情况:

  1. 无业务数据,格式如下:
{
    "code": 200,
    "message": "成功",
    "data": null,
    "specialData": null,
    "timestamp": 1607485350802
}
  1. 单业务数据,格式如下:data内的内容为直接数据
{
    "code": 200,
    "message": "成功",
    "data": {
        "xxx": "xxx",
        "xxx": "xxx"
    },
    "specialData": null,
    "timestamp": 1607485350802
}
  1. 多业务数据,无分页信息,格式如下:data内为业务数据数组
{
    "code": 200,
    "message": "成功",
    "data": [{
        "xxx": "xxx",
        "xxx": "xxx"
    },{
        "xxx": "xxx",
        "xxx": "xxx"
    }],
    "specialData": null,
    "timestamp": 1607485350802
}
  1. 多业务数据,有分页信息,格式如下:data内分两部分,pagination为分页信息,result为具体业务数据数组
{
    "code": 200,
    "message": "成功",
    "data": {
        "pagination": {
            "totalCount" : 0,				// 数据总数
            "totalPages" : 0,				// 总页数
            "pageNumber" : 0,				// 当前页
            "pageSize" : 0,					// 当前页的数量
            "firstPage" : false,			// 是否为第一页
            "lastPage" : false,			// 是否为最后一页
            "hasPreviousPage" : false,		// 是否有前一页
            "hasNextPage" : false			// 是否有下一页
        },
        "result" : [{
            "xxx" : "xxx",
            "xxx" : "xxx"
        },{
            "xxx" : "xxx",
            "xxx" : "xxx"
        }]
    },
    "specialData": null,
    "timestamp": 1607485350802
}

Swagger

后端采用Swagger作为前后端文档技术。

  1. 通用数据:文档中,接口返回数据中的通用数据(一级)和分布信息不在文档中体现,文档中接口返回数据只显示具体需要返回的业务数据,无业务数据返回则文档中无接口返回数据;
  2. 业务数据一般包含几个通用字段,不会在文档中展示,但部分仍会在接口请求后返回,无相关数据的逻辑需要处理可忽略;
{
    "id" : 0,									// 业务数据id,唯一标识
    "createdUserId" : 0,						// 创建人id
    "createdTime" : 1607485350802,				// 创建时间
    "lastModifiedUserId" : 0,					// 最后修改人id
    "lastModifiedTime" : 1607485350802,			// 最后一次更新时间
    "enabled" : 0								// 启用禁用状态
}
  1. 新增数据时,通常在文档请求参数中也会现id唯一标识,可忽略,新增不需要传入该字段;

请求

安全机制

后端提供了三种token模式,具体使用模式,可由开发者决定,并且可以自己扩展实现。下面举例为现有模式

后台管理系统
  1. 请求时须全局携带请求头system_code,具体值会在对接时给出;
  2. 用户登陆之后,会返回tokenrefresh_token,前端需保存本地,并在获取之后的请求中携带两个参数,放入请求头;

以上三个参数在请求头中的属性名分别为:system_codetokenrefresh_token

  1. 前端在请求之后,须全局监听响应信息,若响应头中返回了token,须替换本地的token,并在之后的请求中携带新token;

请求格式

  1. 后端采用非标准Restful格式,无特殊说明,一般请求为POST请求;

  2. 请求类型无特殊情况,为json格式请求,即:Content-Type: application/json;

  3. 分页请求时,分页请求参数在请求参数中,即在url后拼接;

    页码参数名固定为pageNumber,单页数据量参数名固定为pageSize;其它参数仍在json请求体中;

    例:http://xxx.com/xxx?pageNumber=1&pageSize=10

  4. 关于时间数据的处理,前后端统一采用13位时间戳,传值和返回均为时间戳,各自处理转换;

数据字典

后端提供数据字典功能,前端在需要的地方可以调用字典,不建议前端自己枚举写死;

且后端可以在返回时自动翻译字典,需要时可以和后端沟通。

举例:

启用/禁用状态,参数名为enabled,对应值为1/0,前端需要做下拉选择,可调用接口获取。

业务数据中返回包含了enabled该参数,但具体值为1/0,若需要翻译字义展示,可与后端沟通,在返回时直接返回中文转义启用/禁用

帮助工具

linitly-create:创建新项目

本项目框架提供适用于本项目的项目创建生成器,根据使用规则,可以快速的帮助开发者基于本项目结构创建新的项目结构。

详细源代码、帮助文档可以要查看项目:

Gitee地址:https://gitee.com/linitly/linitly-create.git

详细的功能说明,可以查看项目目录中的README文件

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.

简介

本项目是基于SpringBoot2.3、JWT、MyBatis集成一些常用功能的脚手架,旨在简化日常开发。 展开 收起
Apache-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/linitly/linitly-boot.git
git@gitee.com:linitly/linitly-boot.git
linitly
linitly-boot
linitly-boot
master

搜索帮助