# bucket

**Repository Path**: bbbscxy/bucket

## Basic Information

- **Project Name**: bucket
- **Description**: No description available
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-06-29
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#### 模块介绍
##### bucket-common
集成基础项目所需要的依赖
##### bucket-ms-upms
权限管理子模块，提供用户、角色、权限分配
##### bucket-ms-sys
系统设置子模块，提供系统配置、模块管理、接口信息、项目文档
##### bucket-ms-code
自动代码生成
##### bucket-ms-log
日志记录子模块，提供系统日志、登录日志
##### bucket-ms-cms
内容管理子模块，提供文章管理
##### bucket-ms-weixin
微信功能子模块
##### bucket-ms-user
用户中心子模块
##### bucket-ms-shop
电商子模块
##### （5007）bucket-ui-front
提供多套模板化的前端设计页面，包括bootstrap、layui、vue、react等前端框架，根据接口定义可以自由切换版本
##### （5006）bucket-ui-admin
提供多套模板化的后台设计页面，例如layui，根据接口定义可以自由切换版本

#### 代码规范
代码资源 | 说明
----|------
com.vim.common.* | 自定义类
com.vim.modules.web.api | API接口层
com.vim.modules.web.controller | 控制层
com.vim.modules.web.servie | 业务层，继承CrudServiceImpl<T>
com.vim.modules.web.dao | 数据层，继承CrudMapper<T>
com.vim.modules.web.model | 实体层，继承BaseEntity
RestfulResponse | 响应返回数据结构
resources/mapper/*.xml | SQL映射文件
resources/public/module/views/ | 静态页面
resources/public/module/plugins/ | 静态资源引用

接口文档注解 | 说明
----|------
模块 | @ParentModuleInfo(moduleCode = "父级模块标识", moduleName = "父级模块名称")
类 | @Api(value = "模块名称", description = "模块描述")
方法 | @ApiOperation(value = "方法名称", notes="{\"id\":\"1\",\"name\":\"2\"}", httpMethod="GET")
参数 | @ApiImplicitParams({@ApiImplicitParam(name = "参数名称", value = "参数说明", required = true)})

#### 代码说明
1、pom.xml 必须引用 bucket-common 包  
2、静态页面必须引用<script src="/plugins/common.js"></script>，提供 SERVER_URL 服务器地址  
3、静态页面引用js使用 /module/plugins/*   
4、com.vim.modules.web.api 中 *ApiController 命名，/api/* 命名地址

#### 功能介绍
1、Service、Mapper提供基类，提供增、删、改、查方法  
2、定义全局异常处理类，处理系统异常、业务异常、shiro异常和参数不匹配异常  
3、定义Swagger配置类，重写数据处理接口，生成模块化的文档介绍  
4、定义异常枚举类，方便异常返回定义  
5、定义统一返回格式，通过继承的方式进行扩展返回数据类型  
6、WebMvc配置类中定义主模块、子模块的请求拦截处理，规范化页面和插件的访问路径和方式