增删改查接口命名规范

已于 2022-03-22 10:34:46 修改
阅读量5.2k 收藏 21
点赞数 6
分类专栏： SpringBoot 文章标签： java
于 2021-05-23 17:20:42 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/mingyuli/article/details/117197626
版权
本文探讨了阿里集团的Service/Dao层命名规约，包括获取、插入、删除和更新操作的命名约定。同时，介绍了数据对象、传输对象和展示对象的命名策略，如DO、DTO和VO。此外，分享了个人在Service接口和Dao接口命名中的一致做法，如create、delete、update和query等方法。
摘要由CSDN通过智能技术生成

目录

常用的增删改查命名规约

1、阿里命名规范

Service/Dao 层命名规约

领域模型命名规约

2、自己常用规范

常用的增删改查命名规约

1、阿里命名规范

Service/Dao 层命名规约

1） 获取单个对象的方法用 get 做前缀。
2） 获取多个对象的方法用 list 做前缀。
3） 获取统计值的方法用 count 做前缀。
4） 插入的方法用 save（推荐）或 insert 做前缀。
5） 删除的方法用 remove（推荐）或 delete 做前缀。
6） 修改的方法用 update 做前缀。

领域模型命名规约

1） 数据对象：xxxDO，xxx 即为数据表名。
2） 数据传输对象：xxxDTO，xxx 为业务领域相关的名称。
3） 展示对象：xxxVO，xxx 一般为网页名称。
4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

2、自己常用规范

Service 接口命名

  • create
  • delete
  • update
  • query
  • findById
  • findByXXX
  • findXXXList

Dao 接口命名

  • insert
  • delete
  • update
  • select
  • batchInsert
  • selectOne
  • selectById
  • batchUpdate
  • deleteById
CodingALife
关注
专栏目录
java接口方法命名
07-19
return语句有两个作用；程序中的main（）方法必须同时符合4个条件；命名规则示例。
java代码自动生成，模版式工程单表的增删改查接口控制器等
03-03
总结来说，"java代码自动生成，模版式工程单表的增删改查接口控制器等"是一个旨在简化Java开发的工具，通过配置数据库连接和自定义Freemarker模板，可以快速生成标准的CRUD代码，为日常开发工作带来便利。...
API 增删改查命名规范
堕落天使的博客
08-04 1611
API 增删改查命名规范
JAVA 增删改查接口命名规范
bug_love的博客
01-22 9824
开发时，有很多规范，这里写的是命名规范。 Dao 接口命名   insertbatchInsertselectOneselectByIdcountselectListupdatedeleteById   Service 接口命名   addfindByIdfindByXXXfindXXXListmodifyremove
第五章　命名规范
简单真——技术版
07-19 972
第五章　命名规范 5.1       命名概述名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用 GetNextStudent()，而不是 GetNextArrayElement()。 命名原则是：选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免
Java 命名规范(沸点工作室Java组的都看过来)
一条小黑龙的博客
08-28 1473
简介 在本文中，将从大到小，从外到内，总结Java编程中的命名规范。文中将会涉及到日常工作中常见的命名示例，如包命名，类命名，接口命名，方法命名，变量命名，常类命名，抽象类命名，异常类命名以及扩展类命名等。我将按照项目工程目录结构，从包，类(接口，抽象类，异常类)，方法，变量和常量的顺序展开介绍。 1. 包命名规范 包(Package)的作用是将功能相似或相关的类或者接口进行分组管理，便于类的定位和查找，同时也可以使用包来避免类名的冲突和访问控制，使代码更容易维护。通常，包命使用小写英文字母进行命名，并使用
JAVA增查改删（CRUD）方法命名规范
YTenderness的博客
10-08 1309
Service 接口命名 add findById findByXXX findXXXList modify remove Dao 接口命名 insert batchInsert selectOne selectById count selectList update deleteById
mybatis 生成实体类工程 增删改查接口mapper.xml 只需要自己写业务。就是这么流弊
08-27
"mybatis 生成实体类工程 增删改查接口mapper.xml 只需要自己写业务。就是这么流弊" 这个标题揭示了一个高效的解决方案，即使用代码生成工具自动创建这些常见组件，让开发者可以专注于核心业务逻辑，提高开发效率。 ...
GeneratorJavaTools反向工程工具生成mybatis增删改查方法
04-20
GeneratorJavaTools是一款基于Java的反向工程工具，它能够帮助开发者自动生成MyBatis的增删改查（CRUD）方法，极大地提高了开发效率，减少了手动编写SQL和DAO层代码的工作量。 反向工程，又称为逆向工程，是一种将...
JSP+JavaBean+DAO+面向接口编程+工厂模式实现对数据增删改查
01-08
【JSP+JavaBean+DAO+面向接口编程+工厂模式实现对数据增删改查】 在Web开发中，JSP（JavaServer Pages）是用于创建动态网页的技术，它结合了HTML和Java代码，使得开发者可以在服务器端处理业务逻辑并生成HTML响应。...
java命名规范 开发规范
06-19
1. 模块命名、数据库表命名、域模型命名、各分层的类/方法命名、页面的命名； 模块命名： a. 包命名：com.project_name.module_name.action/service/dao/ws； service的实现都置于com.project_name.module_name.service.impl下； b. 接口命名遵守XxxxService，接口实现遵守XxxxServiceImpl； 2. 包的设计、页面的层次结构设计（jsp/css/js等文件的结构）； 3. log、异常（声明式异常）的约定设计； 4. 链接、按钮、表单提交的统一方式；通用式Ajax调用与页面跳转统一模型； 5. 响应一个请求的分层结构约定，列举几个示例（常规调用、Ajax调用、WebService调用、提供WebService暴露、硬件设备接口调用）； 6. 验证代码质量的约定，如JUnit、EMMA、FindBugs、CheckStyle、PMD的使用；Hudson持续集成需注意的； 7. 压力测试、防内存泄漏测试； 基础CSS：标签的各种状态的样式；表格单双行的样式； 开发一个Action请求的响应： 前置条件：该Action涉及的Entity及EntityName.hbm.xml已经准备好。 步骤： a. 前端页面触发Action的请求； 统一采用全路径请求，URL格式： 1> basePath/web/moduleName/*_ *.action {1}  EntityName，{2}  ActionMethodName 2> basePath/web/moduleName/gotoXxx.action （无需调用Service，直接跳转） 包括jQuery的Ajax方式和非Ajax方式； 包括表单提交； 参数设值的方式： 1> URL参数： basePath/web/moduleName/*_*.action?entity.propertyName=paramValue&paramName=paramValue 2> 或 另外，对于表单的提交，前后台都必须做数据校验，SWDF已提供了此能力，进行简单的配置即可，前台直接提供类似以下代码即可，点此查看前端校验详细规则说明。 前端校验示例； 后台数据校验，点此查看校验详细说明. b. 配置struts-moduleName.xml； 直接跳转示例； 调用Service示例； c. 开发对应的{EntityName}Action类； 该类必须继承com.hikvision.swdf.xx.BaseAction，该Action类有一个关键属性entity，即泛型Entity类的一个实体，该属性默认填充好了请求提交过来的entity对应参数（即entity.propertyName）； d. 开发Service接口和Service接口实现，并在Action中通过set方法注入该Service； 接口文件：UserService 接口实现：UserServiceImpl 注入Service e. 开发DAO，DAO继承com.hikvision.xxx.HibernateBaseDAO； 示例 f. 配置applicationContext-*.xml； 配置DAO bean、Service Bean、Action Bean及注入的配置； g. 测试； 备注： 1. Action建议统一遵守通配符的约定，basePath/web/moduleName/*_ *.action {1}  EntityName，{2}  ActionMethodName 2. 统一命名规则：接口类似UserService，接口实现类型UserServiceImpl；（IUserService和UserServiceImpl） 开发一个Action调用关联应用提供的WebService 前置条件：该WebService?WSDL可正常获取 步骤： a. 配置applicationContext-wsclient.xml； Spring管理第三方WebService实例bean Jaxws-client配置代码 b. 生成第三方WebService接口文件；（提供系统自动生成） 自动生成代码 c. 页面调用Action请求，Action中注入WebService实例bean； Action对应方法直接调用第三方WebService的相关方法； d. 测试； 备注： 1. 步骤b，接口文件必须同包名同类名置于src目录下； 开发一个Action调用关联应用开放的HTTP请求 步骤： 1. 页面调用Action请求； 2. Action类相应方法使用封装好的HttpClient相关工具类，准备好HTTP请求的相关参数header参数和body参数并以xml的方式提交HTTP请求； 3. 解析该HTTP请求返回值（XML或JSON）； 4. 响应结果； 5. 测试； 备注： 开发一个需要对第三方应用发布的WebService 步骤： a. 开发WebService接口，@WebService进行注解该接口； b. 开发WebService接口实现类，@WebService注解该实现类，并制定endpointInterface； c. 配置applicationContext-ws.xml d. 测试 备注： 开发一个需要对第三方应用发布的RESTful Service 步骤： a. 开发RS接口，提供如下Annotation； b. 开发RS接口实现，并提供如下Annotation； c. 配置applicationContext-rs.xml 备注： 所有Annotation的涵义解释如下：
客户端用户增删改查接口文档范例
05-03
APP客户端接口文档范例，用户新增修改查询 接口返回json类型
xml qtreewidget 增删改查
05-12
在Qt环境中，结合XML和QTreeWidget进行增删改查操作，我们可以创建一个可视化的数据管理界面。以下是对这些概念的详细说明： **XML基础：** 1. **XML元素和属性**：XML文档由一系列元素构成，每个元素可包含其他...
接口命名示例
求道问术
05-17 7816
方式/GET+POST 参考 分析： 只有GET和POST方式 /业务/模块/唯一操作 参数传递有“链接参数”和“Body参数” 安全性有{access_token} 唯一操作： 创建：create 根据ID删除1个：delete 根据ID列表批量删除：batchdelete 根据ID更新：update 根据ID查找：one 查找所有：all 列表条件查找：list 分页条件查找：page 创建成员 创建成员 - POST - /bin/user/create - 请求参数：{access_toke
增删改查如何命名
peabits' Web Log
02-05 2051
增删改查如何命名 对于常见的“增删改查”方法，命名最好要谨慎 增加： 最常见使用create和add，根据英语的语义进行区分，，create代表创建，add代表增加。 修改： 常见的有alter、update、modify。 查询： 对于获取单个对象，可以用get或load；对于不分条件列举，用list；对于有条件查询，用search。 删除： 常见的有delete和remove，删除建议用de...
C# 接口命名规范
weixin_30394251的博客
05-11 1410
接口命名规范：1.大写约定PascalCasing:帕斯卡命名法,每个单词首字母大写应用场景：命名空间、类型、接口、方法、属性、事件、字段、枚举、枚举值eg:HtmlTag IOStream注意：两个字母的缩略词，两个字母都要大写 IOStream camelCasing:首字母小写（双字母缩写都小写）应用场景：参数eg:htmlTag ioStream 2.通用命名约定word选择：选...
JPA基础增删改查方法命名规则
最新发布
FirstMrRight的博客
05-31 2312
请注意，这些方法的命名需要符合 JPA 方法命名规则，并且与实体类中的字段名和类型相匹配。如果涉及到复杂的条件或多个字段的更新，可能需要使用其他查询方式，如使用 JPQL 或 Criteria 查询等。JPA 提供了一种基于方法命名的查询语法，可以根据方法的命名来自动生成查询。这种命名规则被称为 JPA 方法命名语法规则。
接口命名规范规划思考
清云逸仙的博客
06-22 479
1、场景 元宝商城首页诸多接口命名 元宝商城详情页诸多接口命名 2、现状 大而全的控制层 诸多接口定义在同一控制层类中 对网站页面未来的演进未预留想象空间 3、问题 容易形成臃肿的组件（类） 模块耦合 模块对应功能增多后，重命名接口会造成资源的极大浪费： 需要对新接口回归测试 新老接口替换需要冗余设计 新老切换可能需要停服务使得服务不可用 4、目标 提前预知未来可能的演化方向 模块化规划 为接口使用者（前端、测试人员）提供模块化、结构化、清晰的接口定义 当系统规则不断增长过程
前端使用后端增删改查接口之前，要先将其封装为函数（vue和react均适用）
博客of me
12-31 503
3、编辑接口（put），形参为必选值id和可选值，并将id定为后缀。前端将此接口命名为“updateAbc”。4、删除接口（delete），形参为id， 并将id定为后缀。前端将此接口命名为“deleteAbc”。1、查询接口（get），形参为id，并将id定为后缀。前端将此接口命名为“getAbc”。2、新增接口（post）,形参为可选值。前端将此接口命名为“createAbc”。（以上接口为基础写法，请根据实际情况加以微调）要在其他文件使用以上接口，引入就行了。首先，引入和定义变量。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值