《Java工程师必读手册》——Java编程技巧系列——Java编程技巧之样板代码(1)

简介: 《Java工程师必读手册》——Java编程技巧系列——Java编程技巧之样板代码(1)

前言

 

北宋科学家沈括在《梦溪笔谈》第十八卷《技艺》中这样描述活字印刷术

 

| 庆历中,有布衣毕昇,又为活版。其法用胶泥刻字,薄如钱唇,每字为一印,火烧令坚……若止印三、二本,未为简易;若印数十百千本,则极为神速。

 

在日常编码的过程中,我们可以总结出很多样板代码,就像活字印刷术中的活字一样。当我们编写新的代码时,需要用到这些活字,就把样板代码拷贝过来,修改替换一下就可以了,写起代码来极为神速样板代码其实就是一种样例、一种模式、一种经验……总结的样板代码越多,编写代码的格式越规范、质量越高、速度越快。

 

这里,作者总结了几种常见Java的样板代码,希望起到抛砖引玉的作用,希望大家不断总结和完善,形成自己的样板代码库。


一、 样板代码简介

 

1. 什么是样板代码?

 

样板代码(Boilerplate Code),通常是指一堆具有固定模式的代码块,可以被广泛地应用到各个程序模块。

 

例如,读取文件就是典型的样板代码:

 

image.png 

 

 

2. 样板代码有什么用?

 

样板(Boilerplate),可以拆分为样例(Example)和模式(Pattern)两个单词进行理解——样例(Example)指可以当成一种标准范例,模式(Pattern)指可以作为一种解决方案。当遇到类似的案例时,就把样板代码拷贝过去,根据实际情况进行修改,该案例就被轻松解决了。

 

样板代码的主要作用:

 

提供一种标准样例:可以用于新人学习,能够快速上手并使用;

提供一种解决方案:遇到类似案例时,可以快速利用该方案进行解决;

有助于不断积累经验:当发现一种样例代码时,都会不断地进行优化,力求达到最佳样例;

有助于提高代码质量:样板代码必然通过了时间考验,存在BUG和出错的几率相对比较低;

有助于提高编码速度:利用样板代码编码,只是复制粘贴修改代码,编码速度大幅提高;

有助于统一代码样式:心中有了样板代码,就能保证每次都写出统一样式的代码。

 

3. 如何编写样板代码?

 

适合于样板代码的编写方法有:

 

1) 复制粘贴生成代码

利用复制粘贴样板代码,用好了编码会事半功倍。

 

2) 用文本替换生成代码

利用文本替换生成代码,可以很快生成一段新代码。

 

3) 用Excel公式生成代码

把样板代码先公式化,传入不同的参数,生成不同的代码。

 

 

 

 

4) 用工具或插件生成代码

很多开发工具或插件都提供一些工具生成代码,比如:生成构造方法、重载基类/接口方法、生成Getter/Setter方法、生成toString方法、生成数据库访问方法……能够避免很多手敲代码。

 

5) 用代码生成代码

用代码生成代码,就是自己编写代码,按照自己的样板代码格式生成代码。

 

4. 如何减少样板代码?

 

样板代码Boilerplate Code具有很大的重复性,通常被认为是一种冗余而又不得不写的代码。其实不然,有些样板代码不能减少,只是我们还没有遇到合适的解决方案而已。通常情况下,我们可以通过以下几种方式减少样板代码:

 

1) 利用注解减少样板代码

 

比如,JavaBean模型类中的Getter/Setter就是样板代码,我们可以通过Lombok的@Getter/@Setter注解来减少这样的样板代码。

 

原始代码

 

image.png 

 

优化代码

 

image.png 

 

2) 利用框架减少样板代码

 

比如,MyBatis是一款优秀的持久层框架,封装了获取数据库连接和声明、设置参数、获取结果集等所有JDBC操作。MyBatis可以通过简单的XML或注解来配置和映射原始类型、接口和Java POJOPlain Old Java Objects,普通老式Java对象为数据库中的记录。

 

原始代码

 

image.png

 

优化代码

 

UserDAO.java

 

image.png

 

 

 

 

UserDAO.xml

 

image.png

 

3) 利用设计模式减少样板代码

 

利用设计模式,可以把一些重复性代码进行封装。比如,上面的读取文件行模式代码,就可以用模板方法进行封装。

 

原始代码

 

image.png

 

优化代码

 

image.png

 

5. 消灭不了的样板代码

 

如果样板代码可以被消灭,那么世界上就不存在样板代码了。即便是上一节提供的减少样板代码方法,也不能完全的消灭样板代码,因为这些样板代码依旧存在于框架和模式的实现中。所以,样板代码是消灭不了的。

 

既然不能消灭样板代码,那就应该合理地利用样板代码。提炼一段样板代码,若只用二三次,未为简便;若用数十百千次,则极为神速。下面,列举了几种常见Java的样板代码,描述了样板代码在日常编程中如何提炼和使用。


 接下篇:https://developer.aliyun.com/article/1228117?groupCode=java

 

相关文章
|
4月前
|
Java 开发工具
【Azure Storage Account】Java Code访问Storage Account File Share的上传和下载代码示例
本文介绍如何使用Java通过azure-storage-file-share SDK实现Azure文件共享的上传下载。包含依赖引入、客户端创建及完整示例代码,助你快速集成Azure File Share功能。
411 5
|
4月前
|
Java 数据处理 API
为什么你的Java代码应该多用Stream?从循环到声明式的思维转变
为什么你的Java代码应该多用Stream?从循环到声明式的思维转变
300 115
|
4月前
|
安全 Java 编译器
为什么你的Java代码需要泛型?类型安全的艺术
为什么你的Java代码需要泛型?类型安全的艺术
215 98
|
4月前
|
Java 编译器 API
java最新版和java8的区别,用代码展示
java最新版和java8的区别,用代码展示
366 43
|
4月前
|
安全 Java 容器
告别空指针噩梦:Optional让Java代码更优雅
告别空指针噩梦:Optional让Java代码更优雅
430 94
|
4月前
|
JSON 网络协议 安全
【Java】(10)进程与线程的关系、Tread类;讲解基本线程安全、网络编程内容;JSON序列化与反序列化
几乎所有的操作系统都支持进程的概念,进程是处于运行过程中的程序,并且具有一定的独立功能,进程是系统进行资源分配和调度的一个独立单位一般而言,进程包含如下三个特征。独立性动态性并发性。
246 1
|
4月前
|
JSON 网络协议 安全
【Java基础】(1)进程与线程的关系、Tread类;讲解基本线程安全、网络编程内容;JSON序列化与反序列化
几乎所有的操作系统都支持进程的概念,进程是处于运行过程中的程序,并且具有一定的独立功能,进程是系统进行资源分配和调度的一个独立单位一般而言,进程包含如下三个特征。独立性动态性并发性。
261 1
|
5月前
|
数据采集 存储 弹性计算
高并发Java爬虫的瓶颈分析与动态线程优化方案
高并发Java爬虫的瓶颈分析与动态线程优化方案
Java 数据库 Spring
216 0
|
5月前
|
算法 Java
Java多线程编程:实现线程间数据共享机制
以上就是Java中几种主要处理多线程序列化资源以及协调各自独立运行但需相互配合以完成任务threads 的技术手段与策略。正确应用上述技术将大大增强你程序稳定性与效率同时也降低bug出现率因此深刻理解每项技术背后理论至关重要.
403 16