基本开发规范与指南.docxVIP

开发基本规范（精简版） TOC \o 1-3 \h \z \u 1 整体原则 2 2 Java命名规范 2 3 前后台接口定义原则 3 4 前台开发规范 3 5 后台开发规范 3 整体原则 分层设计和开发，前台负责用户操作响应和数据展现，后台负责逻辑处理和数据存取 支持双语/多语言，通过外部资源文件进行多语言信息配置，源代码中除了注释外不得出现中文，所有代码文件以UTF-8编码 代码管理采用svn，提交前先同步，等待同步完成后有冲突先合并，合并后提交。 数据库原则 数据建模（数据库的数据表设计及更改）由专人负责 严禁使用前台用户的输入值进行SQL拼接，必须以SQL参数化形式进行处理 分层设计和开发，前台负责用户操作响应和数据展现，后台负责逻辑处理和数据存取 权限控制，系统框架会对所有url监控，前台也会对按钮进行控制，所以要区分不同的权限的话一定要每个操作对应一个page，尽量不要在后台page中传参数action=add 或者action=edit，其实也增加不了多少工作量的。做权限的时候前端权限和后端权限理论上是一致的，例如前段看到不能编辑，那么编辑按钮对于的url也是不能访问的，数据权限的话到时候会细讲。 前后台数据交互的性能原则 尽量减少交互次数 初始化界面的时候，保证在1-2次交互内获取完所有数据 响应用户操作的后台数据交互，保证在1次交互内完成 Java命名规范 class以大写字母开头 method以小写字母开头，get获取一个对象，getXxList获取多个，getXxPage获取分页对象。 class和method都不要包含”-“，“_”等字符，以英文字符和数字命名 声明spring的bean name以小写字母开头 包小写，包名中全部小写 模块文件夹全部小写，htm文件开头字母小写，只能字母开头，只能包括字母数字，并遵循驼峰式规范 后端package先分层，后分模块，前台先分模块后分层。 前台htm中对于的js在htm同级的js文件夹下面，这样方便引用和查看。js文件小写，js类大写。 前后台接口定义原则 所有的BO,VO，及任何需要前后台交互的参数和返回对象都必须实现Serializable接口，否则Hessian框架无法进行传递，会抛出异常。 所有的Service接口，必须继承IGenericService接口，除了只读查询外，只要是对数据有操作的，都需要返回OperationResultV，告诉前台是否操作成功，以便处理业务错误信息，比如 public interface IBookingService extends IGenericService{ public OperationResultVoy CreateBooking(VBookingCreation VBookingCreation); } 前后台交互的数据对象尽可能的精简，尽量不传输冗余的属性，因此，即使一个BO完全满足前台界面需要，但是只有少量属性被使用到，那么也需要重新定义一个VO来进行交互 所有page中不写直接查询，全部在service方法中写查询，删除全部采用逻辑删除，所以查询的时候要带上逻辑删除标志，为此我们把查询方法放在service中，这样统一规范，避免在page中直接查询忘记了添加逻辑标志，同时避免代码重写 所有复杂查询，并且不是通过uuid关联的必须自己写dao，并在dao中有需要的时候可以用vo对象 前台开发规范 前台htm中引入js，每个页面要包含引入公共css和js标签，本身业务的js为了方便不采用全路径，采用相对路径。我们把业务js封装成一个类，当然一个页面复杂的话也可以分几个js，每个js就是一个类，在页面加载完以后初始化类进行渲染。在初始化的时候，传入增加编辑修改的全路径url，并从权限控制器中获取权限传入js类这样初始化按钮的状态，没有权限会被disable掉。??? 如果是复杂的添加和修改页面那么不会是用window，那么单独开一个页面，如果是编辑那么在页面中的page中直接查询对象，传入htm页面，页面中用#便签获取信息，避免在htm中重新去后台获取加载一次对象，这样页面显示也更快。 如果是简单的增加编辑，那么直接可以用window弹出框，复制还是新开htm的panel处理。 前台布局实现的话尽量采用现有的例子，尽量采用官方的例子。 前台尽量采用火狐浏览器，并添加调试插件，extjs3.4以上已经开始做兼容，ie6到i9到火狐和谷歌浏览器一般都支持，小问题可以调整下 后台开发规范 所有的Service接口继承自IGenericService，其实现继承自AbstractGenericServiceImpl基类，同时声明事务@Transactional，除了只读