# spring-boot-security

**Repository Path**: zhouyworks/spring-boot-security

## Basic Information

- **Project Name**: spring-boot-security
- **Description**: Spring Boot Security
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-11
- **Last Updated**: 2024-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Java, SpringBoot, Security

## README

# spring-boot-security

#### 介绍
**Spring Boot**
是一个升级版的软件开发平台,它以"快速,灵活,高效,好用"为特点,即可以短时间内开发出强大软件,又可以很好的自主开发编辑,快速适应升级需求变更!
无论是个人、团队、或是企业，都能够用 Gitee 实现代码托管、项目管理、协作开发。

该系统是基于Spring Boot基础开发平台搭建的项目
1. 整体设计结构
    1. 代码分包说明

             com
                 example
                     springboot
                         common    --公共配置相关
                         file      --附件相关
                         generator --代码生成相关
                         syslog    --系统日志相关
                         system    --系统相关类 以下为开发包结构
                             controller 
                             entity
                             mapper
                             service
                                 impl
             resource
                 mapper  --mybatis和mapper相关的文件放此文件中，规范为先建模块名，下放xml文件，xml需以**Mapper.xml结尾
                     file
                         **Mapper.xml
                     generator
                     ...
                 doc --小功能文档
                 static
                     assets --框架中用到的静态资源
                         css
                         images
                         js
                         libs  --需要用到的第三方插件
                         module --跟系统相关的封装插件，不要随便动
                     view
                         error
                         home
                         module --项目中html请放在该文件夹下，并分模块进行放置
                 templates -- beetl模版
                 application.yml --系统相关配置
                 application-dev.yml --开发环境配置
                 application-pro.yml --生产环境配置    

2. 基础包结构规范

        基础包：com.example.springboot.base
        基础工具包：com.example.springboot.utils
        基础异常包：com.example.springboot.exception

3. 子模块包结构规范

       接口包：controller
       实体包：entity
       持久化包：mapper
       业务逻辑包：service
       业务逻辑实现包：service.impl
   > 1. 如果多个子模块需要复用同一个工具类将，此工具类提一层到上层模块包中，依次类推
   > 2. 如果存在代码复用，尽量提到一个类中
   > 3. 编码规范遵循alibaba的代码规范，IDE中安装alibaba代码规范插件，实时检测，修正
   > 4. 如果alibaba的规范和我们的规范存在冲突，以我们的为主
   > 5. 同一类的服务尽量归类到一个接口包里面

4. Mybatis mapper文件目录规范

       1. 文件结构以 “mapper/模块名/实体名Mapper.xml”为主

5. 静态资源文件目录规范
    1. HTML文件存储目录：

           如：
           用户机构角色模块：static\view\module\system
           文件相关的模块：static\view\module\file
    2. JS文件存储目录：

            特定的在js下建模块模块： static\assets\js\
    3. CSS/IMG存储目录：

             特定的在文件夹下建模块模块： static\assets\css\

   > 1. 常规开发JS参考平台开发规范，可以放总js模块文件中
   > 2. 组件类，公共类JS须放到指定的目录中
   > 3. css/imgs 常规开发放到指定目录中
   > 4. 组件类，公共类css/imgs和js放到一起，组成组件包，便于复制分发


# 编码规范
> 仅描述主要注意事项，其他参考alibaba编码规范

    1. 编码规范遵循alibaba的代码规范，IDE中安装alibaba代码规范插件，实时检测，修正
    2. 如果alibaba的规范和我们的规范存在冲突，以我们的为主
    3. 代码注释要清晰，作者不可少
    4. 复杂代码要以逻辑为主分段，注释
    5. 包，类，变量等命名不允许用中文，拼音等，必须用英文，如果英文太长可以适当缩写，如果是专业术语，要用专业术语简写

# API规范
    1. API规范参考Restful风格，不允许出现驼峰命名类的接口