# frameworkInitDemo

**Repository Path**: qiyang_gitee/frameworkInitDemo

## Basic Information

- **Project Name**: frameworkInitDemo
- **Description**: Java environment framework init demo. use springMvc 4 + Thymeleaf + dubbo + Mybatis
- **Primary Language**: Shell
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-05-28
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 style="margin: 0 auto; text-align:center;">项目说明</h1>

# 项目目录结构

	soft-parent
	│
	├──module	--- 模块划分
	│    └─ demo	--- demo模块
	│			├── demo-dao		--- dao包
	│			│   ├── demo-dao-api	--- dao接口
	│			│   └── demo-dao-impl	--- dao实现
	│			│
	│			├── demo-service		--- service包
	│			│   ├── demo-service-api
	│			│   └── demo-service-impl
	│			│
	├──web	--- web划分
	│    └─ demo-web	--- web程序


# 项目所使用的框架及技术

* Servlet 3.0
* Spring 3
* Spring Mvc 3
* Thymeleaf 3
* dubbo 2.8.4
* Mybatis
* jQuery
* Maven
* shiro

# spring/dubbo 配置约定

1. spring初始化通过指定的单一入口配置加载。其它文件通过`<import>`标签进行引入。 入口配置文件名称定义为`spring-main.xml`
2. spring bean 默认采用注解方式进行配置。并开启自动扫描。
3. dubbo 服务和引用同样也采用注解方式配置。

# 日志约定
1. 整个项目采用slf4j日志框架进行代码日志处理接口。**有且仅有一种日志处理接口框架**。
2. 采用logback作为日志输出框架。

## GIT提交注释规范
   A. 目的：git提交注释统一规范，方便查阅不同版本间功能变动情况，有利于快速定位问题。

   B. 分类：新增、修改、删除、BUG(ID)、特殊

   C. 注：单功能提交，避免多、杂、乱提交。
   
1. git 新增示例

    新增：新增数据库xxx表，新增xxx配置文件。新增xxx数据字典。

2. git 修改示例

    修改：修改XXX功能。

3. git 删除示例

    删除：删除XXX功能，同时删除数据库XXX表XXX字段。

4. git BUG(ID)示例

    BUG(5784):BUG已修复完成，未影响到其它功能。

5. git 特殊示例
    
    特殊：因领导需要演示需临时屏蔽支付功能，点击下单跳跃支付步骤直接开卡。后续需设置关开参数。

5. git 其它情况

    新增：新增JOB定时项目模块schedule-binary（与DAO类似、独立启动）。
    
    修改：修改充值流程，当充值支付成功调用C充值接口失败时循环N次调用(JOB定时任务)。

## 命名规范

- url命名
url采用restful风格结构，命名采用全小写英文定义，多单词组合时采用`-`分隔。 例如：`/admin/upload-file`
- html, js, css 等文件名命名
命名采用全小写英文定义，多单词组合时采用`-`分隔。
- css class 定义命名
命名采用全小写英文定义，多单词组合时采用`-`分隔。
- html 标签id命名
命名采用全小写英文定义，多单词组合时采用`-`分隔。