java定义返回码常量_码出规范(四)常量定义

2415a19a1efb

01

各位屏幕前的读者朋友大家早上中午晚上凌晨好,本文是《码出规范》专题的第四篇,文中参考阿里巴巴最新发布的《Java开发手册》,结合《springboot2.x独门秘籍》专题中的项目开发进度,学以致用,让你在开发中码出高效,码出质量。本专题所得收入均捐赠公益事情,希望用技术情怀帮助更多的人。

02

编程规约包括:

常量定义

OOP规约

集合处理

并发处理

控制语句

其中常量定义就是编程规约下的一个子模块,上一篇博客命名风格讲述的是如何规范命名,清晰明了的命名,本期我们分享编码过程中同样很重要的一件事,那就是常量定义。

阿里巴巴常量定义主要内容

【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。

反例:String key = "Id#taobao_" + tradeId;

cache.put(key, value);

// 缓存 get 时,由于在代码复制时,漏掉下划线,导致缓存击穿而出现问题

【强制】在 long 或者 Long 赋值时,数值后使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆,造成误解。

说明:Long a = 2l; 写的是数字的 21,还是 Long 型的 2。

【推荐】不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。

说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解和维护。

正例:缓存相关常量放在类 CacheConsts 下;系统配置相关常量放在类 ConfigConsts 下。

【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、

包内共享常量、类内共享常量。

1) 跨应用共享常量:放置在二方库中,通常是 client.jar 中的 constant 目录下。

2) 应用内共享常量:放置在一方库中,通常是子模块中的 constant 目录下。

反例:易懂变量也要统一定义成应用内共享常量,两位工程师在两个类中分别定义了“YES”的变量:

类 A 中:public static final String YES = "yes";

类 B 中:public static final String YES = "y";

A.YES.equals(B.YES),预期是 true,但实际返回为 false,导致线上问题。

3) 子工程内部共享常量:即在当前子工程的 constant 目录下。

4) 包内共享常量:即在当前包下单独的 constant 目录下。

5) 类内共享常量:直接在类内部 private static final 定义。

【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。

说明:如果存在名称之外的延伸属性应使用 enum 类型,下面正例中的数字就是延伸信息,表示一年中的第几个季节。

正例:

public enum SeasonEnum {

SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);

private int seq;

SeasonEnum(int seq) {

this.seq = seq; }

public int getSeq() {

return seq; } }

03

总结

总结起来,开发中一定要注意常量的定义规则,不符合规范的常量影响的不仅仅是可读性,还可能影响到程序的安全性。

一如既往,期待您的真知灼见…,《码出规范》系列文章以及大厂内部资料将持续更新,如需获取资料或实战案例源码,欢迎点击我的主页呼叫我,乐意为你解决开发中的疑难杂症。

2415a19a1efb

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/563299.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

centos下载mysql_python数据分析之路——centos下载并配置mysql与navicat的使用

python数据分析之路——centos下载并配置mysql与navicat的使用在之前的文章中已经说明了如何购买并配置一台自己的服务器,那么在安装完anaconda之后,为了之后方便用Django进行网站开发与数据分析,需要对数据库进行配置,那么在数据…

php数组遍历相同的元素覆盖_php获取数组中重复数据的两种方法

搜索热词代码如下:PHPfunction FetchRepeatMemberInArray($array) {// 获取去掉重复数据的数组$unique_arr array_unique ( $array );// 获取重复数据的数组$repeat_arr array_diff_assoc ( $array,$unique_arr );return $repeat_arr;} // 测试用例$array array (apple,ipho…

mysql 解压缩安装_[mysql] MySQL解压缩安装步骤

以前装的MySQL出问题了,只好卸载了。又下载了一个mysql-5.6.24-win32.1432006610.zip。msi文件直接安装就行了。这里需要解压到指定目录,配置后可使用。环境变量配置:在 mysql根目录下修改 my-default.ini :# These are commonly set, remove…

php过滤多空格_php正则过滤html标签、空格、换行符的代码(附说明)

$strpreg_replace("/\s/", " ", $str); //过滤多余回车$strpreg_replace("/$strpreg_replace("//si","",$str); //注释$strpreg_replace("//si","",$str); //过滤DOCTYPE$strpreg_replace("//si",…

mysql+json插入_MySQL对JSON数据的增删改查

MySQL从5.7版本开始就支持JSON格式的数据,操作用起来挺方便的。建表在新建表时字段类型可以直接设置为json类型,比如我们创建一张表:CREATE TABLE test_user (id INT PRIMARY KEY AUTO_INCREMENT,name VARCHAR ( 50 ) NOT NULL,info JSON);js…

java手机象棋软件下载,Java手机网络版象棋游戏附源码JAVA游戏源码下载

运行于手机上的中国象棋游戏,鉴于JAVA J2ME技术,本游戏分服务端和客户端,导入JAR包即可在手机上运行,内有开发文档和运用说明。Java手机网络版象棋游戏附源码(1 folders, 2 files, 1.38 KB, 727.25 KB in total.) 源码(…

mysql数据库如何创建表_mysql数据库如何创建数据表

mysql数据库创建数据表的方法是:可以通过CREATE TABLE语句来创建,基本语法:【CREATE TABLE ([表定义选项])[表选项][分区选项];】。要注意的是,创建数据表不能使用SQL语言中的关键字。在 MySQL 中,可以使用 CREATE TAB…

导航无限级菜单 java,Element NavMenu 无限级菜单

数据结构menudata.json{"data":[{"id": 1,"path": "/home","menuName": "商业数据统计","component": "Home","childMenu":[{"id": 2,"path": "/commerc…

mysql 主从一致性_mysql 主从一致性保证

MySQL 主备的基本原理MySQL 主备切换流程.png主备同步流程图备库 B 跟主库 A 之间维持了一个长连接。主库 A 内部有一个线程,专门用于服务备库 B 的这个长连接。一个事务日志同步的完整过程是这样的:在备库 B 上通过 change master 命令,设置…

php study是什么,phpstudy与wamp区别的区别是什么?

phpstudyphpstudy是一个php运行环境的集成包,用户不需要去配置运行环境,就可以使用,phpstudy不仅是一款比较好用的php调试环境工具,并且还包括了开发工具和常用手册,对于新手是有很大帮助的。phpstudy集成最新的Apache…

安装了虚拟机后mysql用不了_在虚拟机上安装mysql,安装好了并且初始化之后,一直无法启动mysql如何解决?...

今天想在自己的虚拟机上安装mysql,安装好了并且初始化之后,一直无法启动mysql.1.service mysql start;报错:mysql is neither service nor target!?2.systemctl start mysql:报错:sysemctl start mysql : Failed to star mysql.s…

java全局机制,java实现全局异常机制

先上自己的代码,后整理下原理知识。下面是自己实现的全局异常机制1.继承Exception,自定义异常类​package com.zichen.xhkq.exception;/**** Title: CustomException* Description: 系统自定义的异常类型,实际开发中可能要定义多种异常类型* authorCNZZ*…

mysql8添加索引_MySQL8.0新特性-新的索引方式

三种新的索引方式1、隐藏索引MySQL8.0 支持隐藏索引(invisible index),不可见索引隐藏索引不会被优化器使用,但需要维护。应用场景:软删除、灰度发布。软删除:不确定当前索引是否需要删除的时候,软删除,不会…

mysql crash定位分析_MySQL实例crash的案例详细分析

【问题描述】我们生产环境有一组集群的多台MySQL服务器(MySQL 5.6.21),不定期的会crash,但error log中只记录了重启信息,未记录crash时的堆栈:mysqld_safe Number of processes running now: 0mysqld_safe mysqld restarted接下来…

matlab 读取照片imread,利用matlab读取图像

怎样用matlab读取20张图片并依次展示出来指定路径下 单个文件夹data中所有图像 P .\data\;% 图像文件夹路径 img_path_list dir(strcat(P,*.jpg));%获取该文件夹中所有jpg格式的图像 N length(img_path_list);%获取图像总数量 for j 1:N%逐一读取图像 image_name img_path…

python元素定位input button_python+selenium 定位到元素,无法点击的解决方法

报错selenium.common.exceptions.WebDriverException: Message: Element is not clickable at point (234.75, 22). Other element would receive the click: 需要点击的按钮页面显示不了,需要下拉滚动条,能看到按钮了才能点1、尝试下拉一段滚动条&#…

seo和php哪个容易学,php好学吗?和其它语言比哪个好学?

PHP入门是很简单的,比起C语言来bai说简单许多du而且门槛也不高,只要搭建好服务器zhi环境便能轻松编程,代dao码写好就直接在浏览器看到运行结果,不用像C语言那样编译运行至于你所说的“晦涩的数学题”,个人认为对于入门…

mysql入门优化_MySQL数据库:MySQL十大优化技巧详解

本文主要向大家介绍了MySQL数据库的MySQL十大优化技巧详解,通过具体的内容向大家展现,希望对大家学习MySQL数据库有所帮助。WEB开发者不光要解决程序的效率问题,对数据库的快速访问和相应也是一个大问题。希望本文能对大家掌握MySQL优化技巧有…

java 函数签名,Java签名getAlgorithm()方法

可以使用getAlgorithm()类java.security.Signature中的方法获得签名对象的算法名称。此方法不需要任何参数,它返回签名对象的算法名称。演示此的程序如下所示-示例import java.security.*;import java.util.*;public class Demo {public static void main(String[] …

oel 7.0 安装 mysql 5_在linux上安装PostgreSQL 9.4并启动和关闭数据库

PostgreSQL是以加州大学伯克利分校计算机系开发的 POSTGRES, Version 4.2为基础的对象关系型数据库管理系统(ORDBMS)。POSTGRES开创的许多概念在很久以后才出现在商业数据库中。PostgreSQL是最初伯克利代码的一个开放源码的继承者。它支持大部分SQL标准并且提供了许多其它现代特…