9.2.程序源码开发规范要求

为了规范编码质量，开发人员必须牢记程序代码开发规范要求。

1. 每日工作开始前，先使用Git在项目中pull拉取最新代码。以免其他同事有代码更新，导致代码不同步。
2. 每日工作完成后，要提交到Git。即可实现备份，协作同事也可同步了解进度。提交的代码，一定要确保编译及功能无误。
   1. 代码提交commit上去前，注意忽略文件不要提交。
   2. 注意commit到本地库后，还需要push到服务器。
3. 所有异常必须要捕获，且要插入到数据库中存日志。
   1. 异常使用try…catch，在catch中使用ExceptionUtil类，写入异常日志库中。

   2. 下面是错误的示例：

      

      正确的处理。使用异常处理类ExceptionUtil中的insertDB方法，记录异常信息到数据库。之后，是否返回则看具体业务场景。

      

4. 数据库查询
   1. select查询，严禁使用select * from。必须要查询指定到具体字段，如select Id,UserName,NickName from。
   2. 接口传输，也是前端需要什么字段就传递什么字段，严禁传递多余字段。服务器网络带宽都是按照流量进行计费，多余网络传输量也会增加服务器成本。
5. 项目的package命名空间是：tech.qidian.erp，而不是com.qidian.tech。公司的域名是www.qidian.tech，或者www.qidiantech.net。不是qidian.com。在创建新项目时，要注意命名规则。
6. 开发框架使用规范
   1. 后台管理类的项目，公司研发了太极平台框架，必须在要此框架上开发。
   2. webservice接口服务类项目。
      1. 无后台，无需在太极平台框架上开发，所以项目中无需引入QiDianAdminCommon、QiDianAdminTemplate这2个jar库。
      2. 可引入QiDianWebCommon库，进行辅助开发。库中封装了数据库连接池与常用增删改查方法，封装了字符串处理。数据库使用技巧，见下一节文章。
      3. 不引入QiDianWebCommon库，可以根据自己所擅长的技术，完全采用自己的框架。比如struct、hibernate等，但是前提是，必须要在规定的时间周期内，按质量要求完成功能模块。
   3. 客户端项目。采用JavaFx技术进行开发。可找一些基于此JavaFx技术的漂亮UI主题风格（免费的或收费的均可），以后作为我们的标准。
   4. 后台页面项目。如果在管理后台中添加内置页面，必须使用与主体风格一致的样式，采用我们规定的INSPINIA主题。如果是新页面，则自由发挥主题样式风格。
   5. 网站前端类项目。公司购买了一套bootstrap前台主题框架Unify，里面有很多可用的展示效果，可引入使用。但并不强制要求使用此主题框架，可根据所长自由选择。
7. 界面标准
   1. 列表显示。
      1. 字符串。列表字段长度短（10个字以内），居中对齐。长度较大（超过10个字），左对齐。超长（30个字以上），需设置“列表最多字符数”属性，进行列表自动截断。
      2. 数字与货币。要右对齐。如果是货币，要设置为货币类型，进行格式化。另外，针对可汇总的业务字段，要设置汇总属性。以便在列表的最后一行显示汇总数据。
      3. 搜索。列表基本上都要加上搜索功能，注意检查核对。时间的一般按照日期段进行搜索。