Java代码格式

简介: 版权声明:欢迎转载,请注明沉默王二原创。 https://blog.csdn.net/qing_gee/article/details/46386761 东汉大臣陈蕃有一则这样的故事,“一屋不扫何以扫天下”,寓意来表明一个大丈夫,如果连自己的居室都不能打扫干净,怎么胸怀天下。
版权声明:欢迎转载,请注明沉默王二原创。 https://blog.csdn.net/qing_gee/article/details/46386761

东汉大臣陈蕃有一则这样的故事,“一屋不扫何以扫天下”,寓意来表明一个大丈夫,如果连自己的居室都不能打扫干净,怎么胸怀天下。《代码整洁之道》就是来劝诫我们程序员写出更优秀的代码,而“格式”一章也恰巧给我们举出了很多原则,以供我们写出更加规整的代码。

格式的目的

好的代码格式,让人赏心悦目,并且随着版本的更迭,让你能够随心所欲的进行变更,而不是每次都痛苦不堪。

垂直格式

类文件的行不应该成千上万行,应尽量保持短小,当然这点很难做到,我们习惯于在一个类中完成多种多样的功能,以至于我们很难将类进行模块化。

这里写图片描述

使用空行进行分割

人的眼睛对段落有着很强烈的直观意识,如果一篇文章从上倒下一直没有分割,那你就会立刻离开。

public static BaseBiz getBaseBizBeansByName(String bizName) {
  return factory.getBean(bizName, BaseBiz.class);
 }

 /**
 * @Description: 根据银行类型获取对应的预签约业务类
 */
 public static BasePerSign getBasePerSignByName(String bankType) {
  return factory.getBean(bankType + "PerSign", BasePerSign.class);
 }

 /**
 * @Description: 根据银行类型获取对应的出金业务类
 */
 public static BaseBiz getMoneyOutByBeanName(String bankType) {
  return factory.getBean(bankType + "MoneyOut", BaseBiz.class);
 }

保持好方法之间的空白行会让代码整体看起来很舒服,空白行帮我们识别出来不同的概念。

垂直方向上的靠近

private static Map<String, String> configs = new HashMap<String, String>();
 private static final String CONFIG_FILE = "conf/hxbconfig.properties";
 private static String path = HXBConfig.class.getClass().getResource("/").getPath() + CONFIG_FILE;
 private static Properties prop = new Properties();

以上是一串相关的代码,彼此之间紧密相连,如果你把这四行代码放置在不同的位置,那就非常糟糕了。

垂直距离

在读一个类文件时,往往需要上下跳动,那么这个时候,如果本来紧密相连的内容跳跃的幅度特别大,此时就容易让人觉得沮丧,因为你要不停的浪费记忆来保持对这些跳转有所意识。

变量声明要尽量出现在其使用的地方,本地变量应该在函数的顶部出现。

for (int i = 0; i < bankDailyPreSettlements.size(); i++) {
public static Message startPerSignBiz(Message msg) throws IOException {

  StringBuilder msgs = new StringBuilder();

  // 对银行进行归类
  for (String bank : getList()) {

   if (bankmemList.size() > 0) {
    BasePerSign biz = SpringUtils.getBasePerSignByName(bank);
    logger.info(biz + "开始启动");

    // 进行数据操作
    msgs.append(biz.dealMembers(bankmemList));
   }
  }

实体变量应在类的顶部声明,因为在设计非常好的类中,实体变量会被很多方法共用。

下面是来自百度的一段解释:

实例(体)变量是和类变量相对应的
类变量也叫静态变量,也就是在变量前加了static 的变量;
实例(体)变量也叫对象变量,即没加static 的变量;
那么他们的区别究竟是什么呢?
类变量和实例变量的区别在于:类变量是所有对象共有,其中一个对象将它值改变,其他对象得到的就是改变后的结果;而实例变量则属对象私有,某一个对象将其值改变,不影响其他对象

public class HXBMoneyIn extends BaseBiz {
 private static Logger logger = Logger.getLogger(HXBMoneyIn.class);
 @Autowired
 private MoneyTransferService moneyTransferService;
 @Override
 public Message dealMsg(Message msgParam) {
  logger.info("华夏银行接收到入金请求...");

moneyTransferService其实就是一个实体变量,所以放在类的顶部。当然对于logger这种静态变量,也是要放在类顶部。

相关函数

若某个函数调用了另外一个函数,则两者应该放在一起,另外调用函数应该放在被调用函数的上方。

public void callAuctionMatch() {
  excuteAuctionMatch();
 }
 private void excuteAuctionMatch() {
  logger.info("启动白盘商品撮合...");
 }

概念相关的代码应该在一起。

public static BaseBiz getMoneyOutByBeanName(String bankType) {
  return factory.getBean(bankType + "MoneyOut", BaseBiz.class);
 }
public static BaseBiz getMoneyInByBeanName(String bankType) {
  return factory.getBean(bankType + "MoneyIn", BaseBiz.class);
 }

横向格式

反正Robert的观点和我刚好吻合,因为现如今显示屏已经变宽,所以行宽保持在120个字符最佳。

水平方向上的格式,我现在基本上使用eclipse的默认格式。

对于水平方向上的区隔与靠近、水平对齐、缩进、空范围,我觉得eclipse做的还不错,我只改进了两点:
1. 120个字符
2. switch格式

这里写图片描述

团队规则

这一点非常重要,我要求我的团队成员遵守我的编码格式,这样两人的代码在SVN库中就不会发生格式的冲突。

我也来提供一小段我自己的代码格式,我认为还不错

public class StartFrontprocessorServer {
 private static Logger logger = Logger.getLogger(StartFrontprocessorServer.class);

 public static void main(String[] args) {
  Constants.init();

  if (ExcheUtil.canRunForExchange(ExchangeUtil.PRIVILEGE_RESULT_TYPE)) {
   Spriils.getSpringContext();

   logger.info("前置机监听交易端请求业务服务器开始启动");
   Frontener listener = new FrontToBHListener(new CloseHandler() {
    @Override
    public void Close() {
    }
   });
   listener.start();

   // 根据当前交易所配置的银行结算类型进行监听器加载
   SettleBanager.startThread("Listener");

   logger.info("前置机V1.0.0.1.20140521");
  } else {
   logger.info("系统已经被禁用,无法使用!");
  }
 }
}
相关文章
|
16天前
|
设计模式 Java
Java设计模式:组合模式的介绍及代码演示
组合模式是一种结构型设计模式,用于将多个对象组织成树形结构,并统一处理所有对象。例如,统计公司总人数时,可先统计各部门人数再求和。该模式包括一个通用接口、表示节点的类及其实现类。通过树形结构和节点的通用方法,组合模式使程序更易扩展和维护。
Java设计模式:组合模式的介绍及代码演示
|
5天前
|
Java
java小工具util系列4:基础工具代码(Msg、PageResult、Response、常量、枚举)
java小工具util系列4:基础工具代码(Msg、PageResult、Response、常量、枚举)
17 5
|
7天前
|
Java API 开发者
探索Java中的Lambda表达式:简洁与强大的代码实践
本文深入探讨Java中Lambda表达式的定义、用法及优势,通过实例展示其如何简化代码、提升可读性,并强调在使用中需注意的兼容性和效率问题。Lambda作为Java 8的亮点功能,不仅优化了集合操作,还促进了函数式编程范式的应用,为开发者提供了更灵活的编码方式。
|
3天前
|
Java 开发者
探索Java中的Lambda表达式:简化你的代码之旅##
【8月更文挑战第62天】 Java 8的发布为开发者带来了诸多新特性,其中最引人注目的无疑是Lambda表达式。这一特性不仅让代码变得更加简洁,还极大地提升了开发的效率。本文将通过实际示例,展示如何利用Lambda表达式来优化我们的代码结构,同时探讨其背后的工作原理和性能考量。 ##
|
6天前
|
Java API 开发者
探索Java中的Lambda表达式:简化代码,提升效率
【9月更文挑战第27天】在Java 8中引入的Lambda表达式为编程带来了革命性的变化。通过简洁的语法和强大的功能,它不仅简化了代码编写过程,还显著提升了程序的执行效率。本文将深入探讨Lambda表达式的本质、用法和优势,并结合实例演示其在实际开发中的应用。无论你是Java新手还是资深开发者,都能从中获得启发,优化你的代码设计。
|
7天前
|
Java Linux Python
Linux环境下 代码java调用python出错
Linux环境下 代码java调用python出错
21 3
|
6天前
|
存储 Java 索引
使用java代码实现左右括号查找
使用java代码实现左右括号查找
|
7天前
|
算法 Java
java 概率抽奖代码实现
java 概率抽奖代码实现
|
16天前
|
Java 程序员 API
Java中的Lambda表达式:简化代码的秘密武器
在Java 8中引入的Lambda表达式是一种强大的编程工具,它可以显著简化代码,提高可读性。本文将介绍Lambda表达式的基本概念、优势以及在实际开发中的应用。通过具体示例,您将了解如何使用Lambda表达式来简化集合操作、线程编程和函数式编程。让我们一起探索这一革命性的特性,看看它是如何改变Java编程方式的。
23 4
|
16天前
|
Java 开发者
探索Java中的Lambda表达式:简化你的代码
【8月更文挑战第49天】在Java 8的发布中,Lambda表达式无疑是最令人兴奋的新特性之一。它不仅为Java开发者提供了一种更加简洁、灵活的编程方式,而且还极大地提高了代码的可读性和开发效率。本文将通过实际代码示例,展示如何利用Lambda表达式优化和重构Java代码,让你的编程之旅更加轻松愉快。