增删改查接口命名规范

已于 2022-03-22 10:34:46 修改
阅读量5.1k 收藏 20
点赞数 5
分类专栏： 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
关注
  • 5
    点赞
  • 踩
  • 20
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
java接口方法命名
07-19
return语句有两个作用；程序中的main（）方法必须同时符合4个条件；命名规则示例。
GeneratorJavaTools反向工程工具生成mybatis增删改查方法
04-20
GeneratorJavaTools是一款基于Java的反向工程工具，它能够帮助开发者自动生成MyBatis的增删改查（CRUD）方法，极大地提高了开发效率，减少了手动编写SQL和DAO层代码的工作量。 反向工程，又称为逆向工程，是一种将...
07---vue前端实现增删改查
Zero摄氏度的博客
12-24 9700
vue前端页面实现增删改查，通过axios调用后端接口，实现功能。还有批量删除等功能。
Java 命名规范（非常全面，可以收藏）
最新发布
2401_84815583的博客
05-10 1438
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。
JAVA 增删改查接口命名规范
bug_love的博客
01-22 9809
开发时，有很多规范，这里写的是命名规范。 Dao 接口命名   insertbatchInsertselectOneselectByIdcountselectListupdatedeleteById   Service 接口命名   addfindByIdfindByXXXfindXXXListmodifyremove
第五章　命名规范
简单真——技术版
07-19 965
第五章　命名规范 5.1       命名概述名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用 GetNextStudent()，而不是 GetNextArrayElement()。 命名原则是：选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免
Java 命名规范(沸点工作室Java组的都看过来)
一条小黑龙的博客
08-28 1450
简介 在本文中，将从大到小，从外到内，总结Java编程中的命名规范。文中将会涉及到日常工作中常见的命名示例，如包命名，类命名，接口命名，方法命名，变量命名，常类命名，抽象类命名，异常类命名以及扩展类命名等。我将按照项目工程目录结构，从包，类(接口，抽象类，异常类)，方法，变量和常量的顺序展开介绍。 1. 包命名规范 包(Package)的作用是将功能相似或相关的类或者接口进行分组管理，便于类的定位和查找，同时也可以使用包来避免类名的冲突和访问控制，使代码更容易维护。通常，包命使用小写英文字母进行命名，并使用
JAVA增查改删（CRUD）方法命名规范
YTenderness的博客
10-08 1291
Service 接口命名 add findById findByXXX findXXXList modify remove Dao 接口命名 insert batchInsert selectOne selectById count selectList update deleteById
xml qtreewidget 增删改查
05-12
在Qt环境中，结合XML和QTreeWidget进行增删改查操作，我们可以创建一个可视化的数据管理界面。以下是对这些概念的详细说明： **XML基础：** 1. **XML元素和属性**：XML文档由一系列元素构成，每个元素可包含其他...
通用mybatis-MySQL增删改查CRUD源码
09-30
本资源"通用mybatis-MySQL增删改查CRUD源码"旨在帮助开发者避免重复编写繁琐的SQL语句和Mapper接口，提高开发效率。以下是关于这个主题的详细知识讲解。 **1. CRUD操作** CRUD是创建(Create)、读取(Retrieve)、更新...
java代码自动生成，模版式工程单表的增删改查接口控制器等
03-03
总结来说，"java代码自动生成，模版式工程单表的增删改查接口控制器等"是一个旨在简化Java开发的工具，通过配置数据库连接和自定义Freemarker模板，可以快速生成标准的CRUD代码，为日常开发工作带来便利。...
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类型
ADO连接SQLServer数据库实现增删改查VC可直接编译通过
11-19
本教程将详细介绍如何使用ADO连接SQL Server数据库，实现增删改查操作，并确保VC++项目能够直接编译通过。 首先，我们需要了解ADO的基本概念。ADO是一个组件对象模型（COM）接口，它提供了一种高效、统一的方式来...
C# 接口命名规范
weixin_30394251的博客
05-11 1391
接口命名规范：1.大写约定PascalCasing:帕斯卡命名法,每个单词首字母大写应用场景：命名空间、类型、接口、方法、属性、事件、字段、枚举、枚举值eg:HtmlTag IOStream注意：两个字母的缩略词，两个字母都要大写 IOStream camelCasing:首字母小写（双字母缩写都小写）应用场景：参数eg:htmlTag ioStream 2.通用命名约定word选择：选...
JPA基础增删改查方法命名规则
FirstMrRight的博客
05-31 2163
请注意，这些方法的命名需要符合 JPA 方法命名规则，并且与实体类中的字段名和类型相匹配。如果涉及到复杂的条件或多个字段的更新，可能需要使用其他查询方式，如使用 JPQL 或 Criteria 查询等。JPA 提供了一种基于方法命名的查询语法，可以根据方法的命名来自动生成查询。这种命名规则被称为 JPA 方法命名语法规则。
接口命名规范规划思考
清云逸仙的博客
06-22 463
1、场景 元宝商城首页诸多接口命名 元宝商城详情页诸多接口命名 2、现状 大而全的控制层 诸多接口定义在同一控制层类中 对网站页面未来的演进未预留想象空间 3、问题 容易形成臃肿的组件（类） 模块耦合 模块对应功能增多后，重命名接口会造成资源的极大浪费： 需要对新接口回归测试 新老接口替换需要冗余设计 新老切换可能需要停服务使得服务不可用 4、目标 提前预知未来可能的演化方向 模块化规划 为接口使用者（前端、测试人员）提供模块化、结构化、清晰的接口定义 当系统规则不断增长过程
前端使用后端增删改查接口之前，要先将其封装为函数（vue和react均适用）
博客of me
12-31 495
3、编辑接口（put），形参为必选值id和可选值，并将id定为后缀。前端将此接口命名为“updateAbc”。4、删除接口（delete），形参为id， 并将id定为后缀。前端将此接口命名为“deleteAbc”。1、查询接口（get），形参为id，并将id定为后缀。前端将此接口命名为“getAbc”。2、新增接口（post）,形参为可选值。前端将此接口命名为“createAbc”。（以上接口为基础写法，请根据实际情况加以微调）要在其他文件使用以上接口，引入就行了。首先，引入和定义变量。
关于接口的命名规约之一
zy103118的博客
07-19 958
SpringBoot增删改查逻辑
08-22
### 回答1： SpringBoot是一种基于Spring框架的快速开发框架，可以轻松地实现增删改查功能。以下是SpringBoot增删改查逻辑的示例代码： 1. 增加数据 ```java @GetMapping("/add") public String add(Model model) { model.addAttribute("user", new User()); return "add"; } @PostMapping("/add") public String addUser(@ModelAttribute("user") User user) { userRepository.save(user); return "redirect:/"; } ``` 2. 查询数据 ```java @GetMapping("/") public String index(Model model) { model.addAttribute("users", userRepository.findAll()); return "index"; } @GetMapping("/search") public String search(@RequestParam("keyword") String keyword, Model model) { List<User> users = userRepository.findByFirstNameContainingIgnoreCase(keyword); model.addAttribute("users", users); return "index"; } ``` 3. 修改数据 ```java @GetMapping("/edit/{id}") public String edit(@PathVariable("id") long id, Model model) { User user = userRepository.findById(id) .orElseThrow(() -> new IllegalArgumentException("Invalid user Id:" + id)); model.addAttribute("user", user); return "edit"; } @PostMapping("/edit/{id}") public String updateUser(@PathVariable("id") long id, @Valid User user, BindingResult result, Model model) { if (result.hasErrors()) { user.setId(id); return "edit"; } userRepository.save(user); model.addAttribute("users", userRepository.findAll()); return "redirect:/"; } ``` 4. 删除数据 ```java @GetMapping("/delete/{id}") public String deleteUser(@PathVariable("id") long id, Model model) { User user = userRepository.findById(id) .orElseThrow(() -> new IllegalArgumentException("Invalid user Id:" + id)); userRepository.delete(user); model.addAttribute("users", userRepository.findAll()); return "redirect:/"; } ``` 以上是SpringBoot增删改查逻辑的基本示例代码，可以根据具体需求进行适当的修改和优化。 ### 回答2： Spring Boot是一个快速开发框架，简化了Java应用程序的开发过程。在Spring Boot中，增删改查（CRUD）操作是常见的数据库操作逻辑。 在进行增加（Create）操作时，我们可以使用Spring Boot提供的JPA（Java Persistence API）或者MyBatis作为持久化框架。通过定义实体类，注解属性映射数据库，然后使用相应的方法来保存实体对象到数据库中。 在进行删除（Delete）操作时，我们可以通过传入实体对象或者实体对象的ID来删除数据库中的对应数据。在Spring Boot中，可以使用Repository或者Mapper中的方法来删除数据。 在进行修改（Update）操作时，我们可以通过查询得到需要修改的实体对象，然后对实体对象的属性进行修改，最后保存到数据库中。在Spring Boot中，可以使用Repository或者Mapper中的方法来查询和更新数据。 在进行查询（Retrieve）操作时，可以使用Repository或者Mapper中的方法根据特定的条件查询数据库，获取满足条件的实体对象。可以使用查询语句、方法命名规则或者注解来实现数据库查询操作。 总之，Spring Boot提供了简单而强大的工具来实现增删改查的逻辑。通过使用JPA或者MyBatis作为持久化框架，定义实体类，注解属性映射数据库，以及使用Repository或者Mapper中的方法，可以轻松地完成各种数据库操作。同时，Spring Boot还提供了事务管理等功能，确保数据操作的一致性和完整性。 ### 回答3： 在使用SpringBoot进行增删改查逻辑时，通常会借助Spring Data JPA来简化数据库操作。下面将分别介绍各个操作的逻辑： 增加（Create）：首先，需要定义一个实体类（Entity），使用注解标识实体类与数据库表的映射关系。接下来，在Repository接口中继承JpaRepository或CrudRepository，该接口提供了一些基本的操作方法，如save()，用于保存新的实体对象到数据库中。此外，可以在Service层中创建相应的方法，将请求数据传递给Repository，完成对象的保存操作。 删除（Delete）：使用Repository接口提供的delete()方法，传入要删除的实体对象或主键，即可将数据库中相应的数据删除。另外，还可以根据自定义的条件进行删除操作，比如根据对象的某个属性值等。 修改（Update）：通过使用Repository接口中的save()方法，传入已修改过的实体对象，即可将修改后的数据保存到数据库中。此外，Spring Data JPA还提供了自定义更新操作方法，可以根据需要进行特定字段的更新。 查询（Retrieve）：可以使用Repository接口提供的findAll()方法，用于获取数据库中的所有数据；findOne()，用于根据主键获取单个实体对象；findByXxx()，用于根据某个字段值进行查询等。此外，还可以通过自定义方法在Repository中定义查询逻辑，根据方法的命名规则生成相应的查询语句。 在Controller中可以处理前端请求，调用Service层的方法完成相关的操作，返回结果给前端。 总之，SpringBoot提供了简便的方式来处理增删改查逻辑，结合Spring Data JPA能够极大地简化与数据库的交互过程，提高开发效率。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值