3 Star 28 Fork 6

cs4380 / cslc-admin

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

cslc-admin

cslc-admin基础权限单体架构,前后端分离项目
后端项目基于Spring Boot、Spring、Spring MVC、MyBatis、MyBatis-plus、Shiro等主流后端技术开发
前端项目基于vue、vuex、element-ui、axios等主流后端技术开发

微信: jk_cloud

一.系统说明

1.目录模块说明

  • admin-ui
    前端项目

  • admin服务
    提供后台管理基础功能的包,供业务项目使用

    • 用户管理管理
    • 组织机构管理
    • 角色权限管理
    • 数据字典管理
    • 系统菜单管理
    • 系统租户管理
  • common服务 提供系统公共基础相关工具的包,供业务项目使用

  • auth服务
    认证授权服务,登陆验证等功能,供业务项目使用

  • biz服务(业务服务)
    业务服务,主程序,做业务系统开发,其他服务打包后注入到此服务(通过pom依赖)

  • generator服务 代码生成器,独立项目,可视化页面操作数据库表生成前后端代码包

  • doc目录 项目相关资料

2.技术架构说明

  • 表单验证采用Hiberante-Validator,前端做表单验证,后台只做验证不做提示,能跳过表单验证的都是非正常操作请求,返回错误统一错误提示
  • 基础技术栈 Spring、Spring MVC、MyBatis、Shiro
  • 插件 Lombok、Swagger、MyBatis-plus、PageHelper
  • 数据库 MySql5.7、Redis3.2
  • jdk17,nodejs12.5

3.代码规范(推荐)

本项目基于 阿里代码规范,采用了常见的代码规范

二、开发环境搭建

环境搭建此处只做整体思路的说明,具体细节有问题可加群交流沟通

1.后端项目环境搭建

1、编辑器插件

  • Lombok插件,需要手动下载并安装到编辑器中
  • maven插件,一般编辑器都自带,只需要和本地maven关联配置即可

2、maven打包

在当前项目根目录执行,目的下载项目相关依赖,打基础包

# 打包当前项目
mvn clean install

3、项目配置

  • 执行目录中的建表sql脚本(/doc/db/base_db.sql)、初始化数据sql脚本(/doc/db/init_data.sql)
  • 配置数据库(mysql、redis),直接调整修改biz服务application.yml中的配置
  • 启动服务BizBootstrap,账号admin,密码123456

2.前端项目环境搭建

前端项目admin-ui说明

三、项目部署

服务器环境jdk17、nginx最新版

3.1 后端部署

通过maven打包业务项目,生成cslc-admin-server.jar部署到云服务器。

  • 启动后端项目,在jar包同级目录创建启动start.sh脚本,通过linux命令执行
  • 关闭后端项目,直接通过linux杀进程命令:kill -9 xxx
#!/bin/bash
nohup java -server -Xms128m -Xmx128m -jar ./cslc-admin-server.jar --spring.profiles.active=prod --spring.config.additional-location=./config.yml >./logs/nohup.out 2>&1 &

3.2 前端部署

在nginx的配置文件中nginx.conf,添加以下配置

    server {
        listen       80;
        # 公网域名或者ip地址
        server_name  www.xxxxx.cn;
        location ^~ /api/ {
           # 后端程序地址
           proxy_pass http://localhost:4380;
           proxy_connect_timeout 500s;
           proxy_read_timeout 500s;
           proxy_send_timeout 500s;
           proxy_set_header Host $host;
           proxy_set_header X-Real-IP $remote_addr;
           proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        }
        
        location / {
            # 前端项目部署目录
            root   /html/cslc-admin-ui/;
            index  index.html index.htm;
        }
    }

3.3 密码加密

3.3.1 得到加密后的数据

public static void main(String[] args) {
    BasicTextEncryptor textEncryptor = new BasicTextEncryptor();
    // 加密所需的salt
    textEncryptor.setPassword("xxxxx");
    // 待配置的加密数据,使用包含 ENC(xxx)
    System.out.println("ENC("+textEncryptor.encrypt("123456")+")");
}

3.3.2 添加已下配置

jasypt:
  encryptor:
    password: rinxt527c # 自己自定义盐值
    algorithm: PBEWithMD5AndDES
    iv-generator-classname: org.jasypt.iv.NoIvGenerator

3.3.3 mysql参考案例

spring:
  datasource:
    password: ENC(xxx) # xxx 替换成自己加密后是数据

四、项目环境推荐文档

4.1 本地开发推荐

4.1 服务器环境推荐

4.3 其他推荐

  • OpenJDK17安装 服务器和本地推荐安装一致的jdk版本
  • IDEA配置外部依赖 SpringBoot支持依赖外部文件配置,直接在idea中配置环境变量,不需要手动修改bootstrap.yml

五、项目预览图

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 [2019] [cs4380 https://gitee.com/xhbug_cs4380 cs4380@163.com] 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.

简介

cslc-admin基础权限单体架构,前后端分离项目 后端项目基于Spring Boot、Spring、Spring MVC、MyBatis、Shiro等主流后端技术开发 前端项目基于vue、vuex、element-ui、axios等主流后端技术开发 展开 收起
Java 等 5 种语言
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
Java
1
https://gitee.com/xhbug_cs4380/cslc-admin.git
git@gitee.com:xhbug_cs4380/cslc-admin.git
xhbug_cs4380
cslc-admin
cslc-admin
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891