sql命名规范 代码结构及一些代码规范建议

原标题：代码结构及一些代码规范建议

文章首发：愚猿公众号

社区链接：https://my.oschina.net/dengfuwei/blog/1611917

一些感悟

代码结构和规范关系到项目的可持续维护以及维护的周期，非常重要，但真正重视并落地的很少

经典的MVC模式一般都能说出来，但真正落地到项目代码结构的时候，却缺少思考

当写代码和找代码让人感觉别扭的时候，就该考虑如何去优化了

一切皆对象，在规划代码结构的时候也需要有面向对象的思维方式

很多张口就是高并发、大数据、高流量等之类高大上词汇的人，缺很少注重代码的基础结构，写出的代码很难让人轻易上手

如果代码结构和规范做得好一点，一般项目有一两个顶梁柱再加一些新手就完全可以搞定。这样既可以节省人力成本，也可以快速培养新人，新加入的成员也能快速融入

以下是整理的一般类型的项目代码结构，仅供参考。部分模块是使用spring boot开发项目的命名，但总体结构思路是一样的，如果不使用spring boot开发项目，只是修改一下名字即可

建议的包结构及简单说明

itopener-parent：顶级maven parent，配置统一的maven插件、依赖包版本管理等

itopener-demo2-model

itopener-demo2-common

itopener-demo2-web

itopener-demo2-api

itopener-demo2-work

itopener-demo2-views

itopener-demo-model：maven模块，存放与表对应的域对象及其枚举定义、查询条件、mapper及操作等

itopener-demo-common：应用的公共模块，主要存放公共的service操作，方便web、work、api等模块公用

itopener-demo-web：web模块，提供web服务（针对有页面的web服务端）

itopener-demo-api：api模块，对外提供http协议的服务（供其他系统调用，无页面）

itopener-demo-sdk：sdk模块，主要存放对外提供的接口的辅助类，如入参出参、调用方式等。接口调用方和提供方公用的模块

itopener-demo-work：work模块，应用所需的自动任务

itopener-demo-views：views模块，纯前端静态资源，方便前后端完全分离

itopener-demo-gateway：应用网关，用于鉴权、配置路由、负载均衡、重试等

com.itopener.demo.model：po对象，与表一一对应，可以增加关联对象的属性，方便返回数据，如订单表关联订单明细表的多条数据，则订单类里可以增加一个订单明细的List属性，但严禁增加查询条件，所有查询均使用conditions包对应的对象作为查询条件（只有一个查询条件的可以直接以条件作为参数，如select(long id)、select(UserCondition condition）

com.itopener.demo.dao：mybatis对mapper的操作，建议使用sqlid的调用方式，更灵活，公用性更强

com.itopener.demo.mapper：mybatis的映射文件，与表一一对应

com.itopener.demo.conditions：查询条件，建议每个表都对应一个查询条件，包含分页、排序、like条件、between条件等属性

com.itopener.demo.enums：model对象中属性对应的枚举，属于model的属性，而并非全局公用，很会放到整个项目的公共模块，我认为有点过度设计

本文来自电脑杂谈，转载请注明本文网址：
http://www.pc-fly.com/a/jisuanjixue/article-77103-1.html