企业级JAVA、数据库等编程规范之命名风格 —— 超详细准确无误

本文主要是介绍企业级JAVA、数据库等编程规范之命名风格 —— 超详细准确无误,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

 🧸欢迎来到dream_ready的博客,📜相信你对这两篇博客也感兴趣o (ˉ▽ˉ;)

📜 表白墙/留言墙 —— 初级SpringBoot项目,练手项目前后端开发(带完整源码) 全方位全步骤手把手教学

📜 用户登录前后端开发(一个简单完整的小项目)——SpringBoot与session验证(带前后端源码)全方位全流程超详细教程

目录

为什么代码需要遵循命名风格?

企业规范

包名 —— 统一小写

类名 —— 大驼峰

方法名、参数名、成员变量、局部变量 —— 小驼峰

常量命名 —— 全部大写

抽象类、异常类、测试类 —— 固定开头或结尾

数据库及其字段 —— 蛇形

css等 —— 串行


在JAVA中,有一些命名约定和风格指南,以确保代码的可读性和一致性

为什么代码需要遵循命名风格?

        想象一种场景,你到一个新的公司维护老项目,这个老项目里面的包名、类名、变量名定义的乱七八糟甚至有中文,而你之前的公司都严格的遵守代码规范,你一看到这个命名风格就知道这段代码是在干什么,这两种情况你喜欢哪个呢?毋庸置疑是严格遵守代码规范的项目

        代码命名风格是一种最佳实践,可以提高代码的质量、可维护性和可读性,减少错误和混淆,避免混乱和不必要的争议

以下从细致入微的出发点解释为什么代码需要遵循命名风格?

  •           可读性:有意义的命名使代码更容易理解。当变量、函数和类的名称清晰明了时,其他开发人员(包括你自己将来)可以更快地理解代码的功能和目的。
  •         减少歧义:一致的命名风格可以减少命名歧义。例如,在一个项目中,如果约定了使用驼峰命名法,那么其他开发人员会知道如何正确解释和使用变量名。
  •         易于维护:清晰的命名风格使代码更易于维护。当需要修改或添加新功能时,有意义的名称可以帮助开发人员更快地理解代码,并减少错误。
  •         提高可搜索性:一致的命名风格使代码更容易搜索和查找。开发人员可以快速定位到特定的变量、函数或类,而无需查看大量代码。
  •         降低学习成本:新加入的团队成员或其他开发人员可以更快地适应项目,因为他们可以根据命名风格来理解代码。这降低了学习和适应新代码的成本。
  •         代码审查:在进行代码审查时,清晰的命名风格可以帮助审查者更容易发现潜在的问题或改进点。
  •         规范性:遵循一致的命名规则和风格是项目开发的一部分,有助于维护团队的一致性和统一性,避免混乱和不必要的争议。  

企业规范

        首先、提一点、代码中的所有命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式

包名 —— 统一小写

包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词

        比如应用工具类包名为 ​​com.alibaba.open.util​​​

        我上面没有包含点分隔符的包名,因为我将包都展开了(这样子做的目的只是看着更舒服,也更好操作,但不强制),不展开的话如下:

解决包名合并问题 IDEA/idea 左侧包名合并/在一起了 解决办法,超实用

类名 —— 大驼峰

类名使用大驼峰风格,但以下情形例外:DO/BO/DTO/VO/AO

        大驼峰:所有单词首字母都需要大写,又叫帕斯卡命名法,比如UserController

        DO/BO/DTO/VO/AO等例外,比如 OrderVOUserDTO

方法名、参数名、成员变量、局部变量 —— 小驼峰

        方法名、参数名、成员变量、局部变量统一使用小驼峰风格

        小驼峰:除了第一个单词,其他单词单词首字母都大写,比如 userController、​​localValue 、 getHttpMessage() 、 inputUserId

常量命名 —— 全部大写

常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长

比如 MAX_STOCK_COUNT​

抽象类、异常类、测试类 —— 固定开头或结尾

抽象类命名使用 ​​Abstract​​​ 或 ​​Base​​​ 开头;异常类命名使用 ​​Exception​​​ 结尾;测试类命名以它要测试的类的名称开始,以 ​​Test​​ 结尾

数据库及其字段 —— 蛇形

数据库库名、表名、字段名均采用蛇形命名法

蛇形:用下划线(_)作为单词间的分隔符,一般小写(实际使用情况必须大写),又叫下划线命名法,比如:user_controller

css等 —— 串行

串行:用短横线(-)作为单词间的分隔符,又叫脊柱命名法,比如:user-controller

🧸欢迎您于百忙之中阅读这篇博客,📜希望这篇博客给您带来了一些帮助,祝您生活愉快!

这篇关于企业级JAVA、数据库等编程规范之命名风格 —— 超详细准确无误的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/321685

相关文章

springboot健康检查监控全过程

《springboot健康检查监控全过程》文章介绍了SpringBoot如何使用Actuator和Micrometer进行健康检查和监控,通过配置和自定义健康指示器,开发者可以实时监控应用组件的状态,... 目录1. 引言重要性2. 配置Spring Boot ActuatorSpring Boot Act

使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)

《使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)》在现代软件开发中,处理JSON数据是一项非常常见的任务,无论是从API接口获取数据,还是将数据存储为JSON格式,解析... 目录1. 背景介绍1.1 jsON简介1.2 实际案例2. 准备工作2.1 环境搭建2.1.1 添加

Java实现任务管理器性能网络监控数据的方法详解

《Java实现任务管理器性能网络监控数据的方法详解》在现代操作系统中,任务管理器是一个非常重要的工具,用于监控和管理计算机的运行状态,包括CPU使用率、内存占用等,对于开发者和系统管理员来说,了解这些... 目录引言一、背景知识二、准备工作1. Maven依赖2. Gradle依赖三、代码实现四、代码详解五

java如何分布式锁实现和选型

《java如何分布式锁实现和选型》文章介绍了分布式锁的重要性以及在分布式系统中常见的问题和需求,它详细阐述了如何使用分布式锁来确保数据的一致性和系统的高可用性,文章还提供了基于数据库、Redis和Zo... 目录引言:分布式锁的重要性与分布式系统中的常见问题和需求分布式锁的重要性分布式系统中常见的问题和需求

SpringBoot基于MyBatis-Plus实现Lambda Query查询的示例代码

《SpringBoot基于MyBatis-Plus实现LambdaQuery查询的示例代码》MyBatis-Plus是MyBatis的增强工具,简化了数据库操作,并提高了开发效率,它提供了多种查询方... 目录引言基础环境配置依赖配置(Maven)application.yml 配置表结构设计demo_st

在Ubuntu上部署SpringBoot应用的操作步骤

《在Ubuntu上部署SpringBoot应用的操作步骤》随着云计算和容器化技术的普及,Linux服务器已成为部署Web应用程序的主流平台之一,Java作为一种跨平台的编程语言,具有广泛的应用场景,本... 目录一、部署准备二、安装 Java 环境1. 安装 JDK2. 验证 Java 安装三、安装 mys

Springboot的ThreadPoolTaskScheduler线程池轻松搞定15分钟不操作自动取消订单

《Springboot的ThreadPoolTaskScheduler线程池轻松搞定15分钟不操作自动取消订单》:本文主要介绍Springboot的ThreadPoolTaskScheduler线... 目录ThreadPoolTaskScheduler线程池实现15分钟不操作自动取消订单概要1,创建订单后

详谈redis跟数据库的数据同步问题

《详谈redis跟数据库的数据同步问题》文章讨论了在Redis和数据库数据一致性问题上的解决方案,主要比较了先更新Redis缓存再更新数据库和先更新数据库再更新Redis缓存两种方案,文章指出,删除R... 目录一、Redis 数据库数据一致性的解决方案1.1、更新Redis缓存、删除Redis缓存的区别二

oracle数据库索引失效的问题及解决

《oracle数据库索引失效的问题及解决》本文总结了在Oracle数据库中索引失效的一些常见场景,包括使用isnull、isnotnull、!=、、、函数处理、like前置%查询以及范围索引和等值索引... 目录oracle数据库索引失效问题场景环境索引失效情况及验证结论一结论二结论三结论四结论五总结ora

JAVA中整型数组、字符串数组、整型数和字符串 的创建与转换的方法

《JAVA中整型数组、字符串数组、整型数和字符串的创建与转换的方法》本文介绍了Java中字符串、字符数组和整型数组的创建方法,以及它们之间的转换方法,还详细讲解了字符串中的一些常用方法,如index... 目录一、字符串、字符数组和整型数组的创建1、字符串的创建方法1.1 通过引用字符数组来创建字符串1.2