springcloud-config
如何运行
请使用mvn:spring-boot:run
命令运行,不要使用main()
方法运行,否则对静态资源修及模板文件的修改不会立即生效,影响开发效率。
开发规范
- 尽量精简项目大小,不要随便添加类和造轮子,需要工具类的话首先从apache-commons-*和guava中找,那里面的工具类基本满足本项目90%开发需求。
- Java代码风格保持统一,可以参考阿里巴巴Java开发手册(正式版)。
- 类与方法不应该过大,如果方法内代码行数过多应拆分并重构该方法,如果类内方法过多应拆分并重构该类,以便复用及减少重复代码。
Model
对象不允许添加任何与其对应数据表无关的成员变量(字段),如果需要添加的话请在com.module.product.common.dto
下创建相应的DTO,如StudentDto
。- 单表查询可不用写SQL,直接使用通用
Mapper
的Condition
对象以编程方式完成,连表查询必须在对应的XML中编写SQL。无论使用哪种方式,请考虑SQL的性能,至少做到用到什么字段查什么字段,严禁无脑select *
。 - 通常情况下不要自行处理异常,遇到业务异常应创建
com.module.core.exception.ServiceException
并抛出交由异常处理器统一处理。 注意,ServiceException
内的message
会作为返回JSON的消息部分,请根据业务认真填写,有的甚至直接作为文案显示,比如throw new ServiceException("验证码不正确");
)。 js、css、html、jsp、properties、xml
等文件名称包含多单词时必需用分次符(-)拼接,如user-center.html、user-center.js
,HTML内元素id、attribute命名也应遵守该命名约定,如<button id="btn-create-order"></button>
。
开发流程
- 克隆项目至IDE并切换至dev分支
- 使用
com.module.product.CodeGenerator
代码生成工具生成对应数据表(Model
)的基础代码。 - 创建对应的jsp、js文件。