设计模式学习笔记 - 开源实战三（中）：剖析Google Guava中用到的设计模式

2024-04-21 07:28
文章标签 实战 学习 设计模式 剖析 笔记 开源 google 用到 guava

本文主要是介绍设计模式学习笔记 - 开源实战三（中）：剖析Google Guava中用到的设计模式，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

概述

上篇文章，我通过 Google Guava 这样一个优秀的开源类库，讲解了如何在业务开发中，发现跟业务无关、可以复用的通用功能模块，并将它们抽离出来，设计成独立的类库、框架或功能组件。

本章再来学习下，Google Guava 中用到的几中经典的设计模式：Builder 模式、Wrapper 模式，以及之前没有讲过的 Immutable 模式。

Builder 模式在 Google Guava 中的应用

在项目开发中，我们常用到缓存，它可以有效地提高访问速度。

常用的缓存系统有 Redis、Memcache 等。但是，如果要缓存的数据比较少，我们完全没必要再项目中独立部署一套缓存系统。毕竟系统都有一定的出错率，项目中包含的系统越多，那组合起来，项目整体出错的几率就会升高，可用性就会降低。同时，多引入一个系统就要多维护一个系统，项目的维护成本就会变高。

取而代之，我们可以在系统内部构件一个内存缓存，跟系统集成在一起开发、部署。那如何构建内存缓存呢？ 我们可以基于 JDK 提供的类。比如 HashMap ，从零开始开发内存缓存。不过，从零开发一个缓存，涉及的工作会比较多，比如缓存淘汰策略等。为了简化开发，我们就可以使用 Google Guava 提供的线程的缓存工具类 com.google.connom.cache.*。

使用 Google Guava 来构建内存缓存非常简单，下面是我我写的一个例子。

public class CacheDemo {public static void main(String[] args) {Cache<String, String> cache = CacheBuilder.newBuilder().initialCapacity(100).maximumSize(1000).expireAfterWrite(10, TimeUnit.SECONDS).build();cache.put("key1", "value1");String value = cache.getIfPresent("key1");System.out.println(value);}
}

从上面的代码可以看出，Cache 对象是通过 CacheBuilder 这样一个 Builder 类来创建的。为什么要由 Builder 类来创建 Cache 对象呢？这个问题现在对你来说应该没有难度了吧，在建造者模式章节，已进行了详细的讲解了。

构建一个缓存，需要配置 n 多个参数，比如过期时间、淘汰策略、最大缓存大小等等。相应地，Cache 类就会包含 n 多成员变量。我们需要在构造函数中，设置这些成员变量的值，但又不是所有的值都必须设置，设置哪些由用户来决定。为了满足这个需求，我们就需要定义多个包含不同参数列表的构造函数。

为了避免构造函数的参数列表过长、不同的构造函数过多，一般由两种解决方案。其中，一个解决方案是使用 Builder 模式。另一个方案是先通过无参构造函数创建对象，然后再通过 setXXX() 方法来逐一设置成员变量。

为什么 Google Guava 选择第一种而不是第二种解决方案呢？使用第二种解决方案是否也可以呢？大难是不行的。至于为什么，看下面的源码就清楚了。我们把 CacheBuilder 类中的 build() 函数摘抄到了下面。

    public <K1 extends K, V1 extends V> Cache<K1, V1> build() {this.checkWeightWithWeigher();this.checkNonLoadingCache();return new LocalManualCache(this);}private void checkNonLoadingCache() {Preconditions.checkState(this.refreshNanos == -1L, "refreshAfterWrite requires a LoadingCache");}private void checkWeightWithWeigher() {if (this.weigher == null) {Preconditions.checkState(this.maximumWeight == -1L, "maximumWeight requires weigher");} else if (this.strictParsing) {Preconditions.checkState(this.maximumWeight != -1L, "weigher requires maximumWeight");} else if (this.maximumWeight == -1L) {logger.log(Level.WARNING, "ignoring weigher specified without maximumWeight");}}

必须使用 Builder 模式的主要原因是，在真正构造 Cache 对象时，必须做一些必要的参数校验，也就是 build() 函数中的前两行代码要做的工作。如果采用无参默认构造函数加 setXXX() 方法的方案，这个校验就无处安放了。而不经过校验，创建的 Cache 对象有可能是不合法的，不可用的。

Wrapper 模式在 Guava 中的应用

在 Google Guava 的 collection 包路径下，有一组以 Forwarding 开头命名的类。

在这里插入图片描述
这组 Forwarding 开头命名的类虽然很多，但实现方式都很相似。下面是照抄了其中的 ForwardingCollection 中的部分代码，你可以思考下这组 Forwarding 类是干什么用的。

@GwtCompatible
public abstract class ForwardingCollection<E> extends ForwardingObject implements Collection<E> {// TODO(lowasser): identify places where thread safety is actually lost/** Constructor for use by subclasses. */protected ForwardingCollection() {}@Overrideprotected abstract Collection<E> delegate();@Overridepublic Iterator<E> iterator() {return delegate().iterator();}@Overridepublic int size() {return delegate().size();}@CanIgnoreReturnValue@Overridepublic boolean removeAll(Collection<?> collection) {return delegate().removeAll(collection);}@Overridepublic boolean isEmpty() {return delegate().isEmpty();}@Overridepublic boolean contains(Object object) {return delegate().contains(object);}@CanIgnoreReturnValue@Overridepublic boolean add(E element) {return delegate().add(element);}@CanIgnoreReturnValue@Overridepublic boolean remove(Object object) {return delegate().remove(object);}@Overridepublic boolean containsAll(Collection<?> collection) {return delegate().containsAll(collection);}@CanIgnoreReturnValue@Overridepublic boolean addAll(Collection<? extends E> collection) {return delegate().addAll(collection);}@CanIgnoreReturnValue@Overridepublic boolean retainAll(Collection<?> collection) {return delegate().retainAll(collection);}@Overridepublic void clear() {delegate().clear();}@Overridepublic Object[] toArray() {return delegate().toArray();}// ...
}

光看 ForwardingCollection 的代码实现，你可能想不到它的作用。下面是一个它的用法示例。

public class AddLoggingCollection<E> extends ForwardingCollection<E> {private static final Logger logger = LoggerFactory.getLogger(AddLoggingCollection.class);private Collection<E> originalCollection;public AddLoggingCollection(Collection<E> originalCollection) {this.originalCollection = originalCollection;}@Overrideprotected Collection<E> delegate() {return this.originalCollection;}@Overridepublic boolean add(E element) {logger.info("Add element: " + element);return this.delegate().add(element);}@Overridepublic boolean addAll(Collection<? extends E> collection) {logger.info("Size of elements to add: " + collection.size());return this.delegate().addAll(collection);}
}

在上面的代码中， AddLoggingCollection 是基于代理模式实现的一个代理类，它在原始 Collection 类的基础上，针对 Add 相关操作，添加了记录日志的功能。

前面讲过，代理模式、装饰器、适配器模式都可以成为 Wapper 模式，通过 Wrapper 类二次封装原始类。它们的代码也很相似，都可以通过组合的方式，将 Wrapper 类的函数实现委托给原始类的函数来实现。

public interface Interf {void f1();void f2();
}
public class OriginalClass implements Interf {@Overridepublic void f1() {// ...}@Overridepublic void f2() {// ...}
}
public class WrapperClass implements Interf {private OriginalClass originalClass;public WrapperClass(OriginalClass originalClass) {this.originalClass = originalClass;}@Overridepublic void f1() {// 附加功能...originalClass.f1();// 附加功能...}@Overridepublic void f2() {originalClass.f2();}
}

实际上，这个 ForwardingCollection 类是一个 “默认 Wrapper 类” 或者叫 “缺省 Wrapper 类”。它类似在装饰器模式章节中，讲到的 FilterInputStream。你可以回头去看下。

如果我们不使用这个 ForwardingCollection，而是让 AddLoggingCollection 类直接实现 Collection 接口，那 Collection 接口中的所有方法，都要在 AddLoggingCollection 类中实现一遍，而真正需要添加日志的功能只有 add() 和 addAll() 两个函数，其他函数的实现，都只是类似 Wrapper 类中的 f2() 函数的实现那样，简单地委托给原始 Collection 类对象的对应函数。

为了简化 Wrapper 模式的代码实现，Guava 提供一系列缺省的 Forwarding 类。用户在实现自己的 Wrapper 类时，基于缺省的 Forwarding 类来扩展，就可以只实现自己关心的方法，其他不关心的方法使用缺省 Forwarding 类的实现，就像 AddLoggingCollection 类的实现那样。

Immutable 模式在 Guava 中的应用

Immutable 模式，中文叫不变模式，它不属于经典的 23 种设计模式，但作为一种较常用的设计思路，可以总结为一种设计模式来学习。一个对象的状态在对象创建之后就不再改变，这就是所谓的不变模式。其中涉及的类就是不变类（Immutable Class），对象就是不变对象（Immutable Object）。在 Java 中，最常用的不变类就是 String 类，String 对象一旦创建之后就无法改变。

不可变模式分为两类，一类是普通模式不变模式，另一类是深度不变模式（Deeply Immutable Pattern）。

  • 普通不变模式指的是，对象中包含的引用对象是可变的。如果不特别说明，通常我们所说的不变模式，指的就是普通的不变模式。
  • 深度不变模式指的是，对象包含的引用对象也不可能。

它们之间的关系，有点类似之前讲过的浅拷贝和深拷贝之间的关系。下面是一个示例代码：

// 普通不变模式
public class User {private String name;private int age;private Address addr;public User(String name, int age, Address addr) {this.name = name;this.age = age;this.addr = addr;}// 只有getter，无setter方法...
}
public class Address {private String province;private String city;public Address(String province, String city) {this.province = province;this.city = city;}// 有getter，也有setter方法...
}// 深度不变模式
public class User {private String name;private int age;private Address addr;public User(String name, int age, Address addr) {this.name = name;this.age = age;this.addr = addr;}// 只有getter，无setter方法...
}
public class Address {private String province;private String city;public Address(String province, String city) {this.province = province;this.city = city;}// 只有getter，无setter方法...
}

在某个业务场景下，如果一个对象符合创建之后不会被修改这个特性，那我们就可以把它设计成不变类。显示地强制它不可变，这样能避免意外被修改。那如何将一个类设置为不可变类呢？其实方法很简单，只要这个类满足：所有成员变量都通过构造函数一次性设置好，不暴露任何 set 等修改成员变量的方法。此外，因为数据不变，所以不存在并发读写问题，因此不变模式常用在多线程环境下，来避免线程加锁。所以，不变模式也常被归为多线程设计模式。

接下来，我们来看一下特殊的不变类，那就是不变集合。Google Guava 针对集合（Collection、List、Set、Map…）提供了对应地不变集合类（ImmutableCollection、ImmutableList、ImmutableSet、ImmutableMap…）。刚刚讲过，不变模式分为两种，普通不变模式和深度不变模式。Google Guava 提供的不变集合类属于前者，也就是说集合中的对象不会增删，但对象的成员变量是可以改变的。

实际上，JDK 也提供了不变集合类（UnmodifiableCollection、UnmodifiableList、UnmodifiableSet、UnmodifiableMap…）。它和 Google Guava 提供的不便集合类的区别在哪里呢？我举个例子就明白，代码如下所示：

public class Immutabledemo {public static void main(String[] args) {List<String> originalList = new ArrayList<>();originalList.add("a");originalList.add("b");originalList.add("c");List<String> jdkUnmodifiableList = Collections.unmodifiableList(originalList);List<String> guavaImmutableList = ImmutableList.copyOf(originalList);//jdkUnmodifiableList.add("d"); // 抛出UnsupportedOperationException//guavaImmutableList.add("d"); // 抛出UnsupportedOperationExceptionoriginalList.add("d");// 输出结果：// a b c d // a b c d // a b c print(originalList);print(jdkUnmodifiableList);print(guavaImmutableList);}private static void print(List<String> list) {for (String s : list) {System.out.print(s + " ");}System.out.println();}
}

这篇关于设计模式学习笔记 - 开源实战三（中）：剖析Google Guava中用到的设计模式的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/922494。

相关文章

Spring项目进阶实战之数据库读写分离开发（多数据源配置）

Spring项目进阶实战之数据库读写分离开发（多数据源配置）

编程技术栈 2017-11-27 18:11:35 数据库 随着项目的不断扩展，对数据库访问的压力也再逐渐加大，除了使用缓存来减轻数据库服务压力外，还可以对数据库进行读写分离来提高服务整体负载能力。下面就进入正文，开始介绍如何在Spring项目中使用多数据源来完成对数据库的读写访问。 配置数据源 首先要对Spring的配置文件进行修改，有原来的单数据源配置成两个数据源，具体代码如下
阅读更多...
沉淀了一套可视化搭建方案，最终决定开源了

沉淀了一套可视化搭建方案，最终决定开源了

hello，大家好，我是徐小夕。之前和大家分享了很多可视化，零代码和前端工程化的最佳实践，最近也在迭代可视化文档知识引擎Nocode/WEP，其中包含了搭建模块，由于最近精力有限，会聚焦于文档引擎部分，所以目前把搭建模块完全开源， 大家如果想学习研究低代码可视化的，可以参考一下这个上项目。 6201.gif 往期精彩 零代码+AI的阶段性复盘文档引擎+AI可视化打造下一代文档编辑器爆肝100
阅读更多...
大学生笔记

大学生笔记

递归是什么？ 调用自身函数称为递归函数 function fn(){fn()}fn() 递归的作用和循环是基本一样的 编写递归函数，一定要包含两个条件 1.基线条件 2.递归条件 接下来我用几个实例为大家带来递归的用法 1.使用递归让延迟器有定时器的效果 function timer() {setTimeout(() => {console.log(1)// 1s后重新调
阅读更多...
Java程序员笔记——全面了解 Nginx 到底能做什么？

Java程序员笔记——全面了解 Nginx 到底能做什么？

JavaSpring高级进阶 2019-01-09 13:03:08 前言 本文只针对Nginx在不加载第三方模块的情况能处理哪些事情，由于第三方模块太多所以也介绍不完，当然本文本身也可能介绍的不完整，毕竟只是我个人使用过和了解到过得。所以还请见谅，同时欢迎留言交流 Nginx能做什么 1.反向代理2.负载均衡3.HTTP服务器（包含动静分离）4.正向代理 以上就是我了解到的Nginx在
阅读更多...
Java程序员笔记，Spring构造器注入原理细节分析

Java程序员笔记，Spring构造器注入原理细节分析

JavaSpring高级进阶 2019-01-22 17:31:28 开篇 Spring IOC是面试常问的知识点。本文讲述了从自定义注册Bean开始，到解析IOC容器初始化Bean的判断的一系列过程，从现象看本质，分析了Spring中的构造器注入的原理，并且分析了各种情况，相信理解了的读者将来遇到这类的别的问题可以独立思考出答案。 1. 示例 先来看一个例子，看看什么是构造器注入。 这
阅读更多...
java实用工具Google Guava，谷歌出品必是精品

java实用工具Google Guava，谷歌出品必是精品

程序员界的彭于晏 2018-12-19 07:42:00 jar包获取方式：   Guava 是一个 Google开发的 基于java的类库集合的扩展项目，包括 collections, caching, primitives support, concurrency libraries, common annotations, string processing, I/O, 等等. 这
阅读更多...
动态代理（黑马笔记）

动态代理（黑马笔记）

一、BigStar 大明星类 package com.itheima.mydynamicproxy1;public class BigStar implements Star {//实现接口要重写里边的抽象方法private String name;public BigStar() {}public BigStar(String name) {this.name = name;}//
阅读更多...
Redis 布隆过滤器实战「缓存击穿、雪崩效应」

Redis 布隆过滤器实战「缓存击穿、雪崩效应」

Java高级互联网架构 2019-03-22 13:52:38 为什么引入 我们的业务中经常会遇到穿库的问题，通常可以通过缓存解决。 如果数据维度比较多，结果数据集合比较大时，缓存的效果就不明显了。 因此为了解决穿库的问题，我们引入Bloom Filter。 我们先看看一般业务缓存流程：   先查询缓存，缓存不命中再查询数据库。 然后将查询结果放在缓存中即使数据不存在，也需要创建一个
阅读更多...
数学基础——微积分在机器/深度学习上的应用

数学基础——微积分在机器/深度学习上的应用

目录 微分学 导数 偏导数 梯度 梯度下降算法 反向传播算法  自动求导  计算图 正则化与过拟合  L1正则化 L2正则化 Dropout正则化 拉格朗日对偶问题 拉格朗日乘数法 凸优化 对偶问题 KKT条件 Slater条件 积分学  笔记内容 微积分是17世纪后半叶发展起来的数学的一个分支。微积分有两个分支：微分学和积分学。 微分学
阅读更多...
【深度学习在自然语言处理（NLP）中的应用：开启语言理解的新纪元】

【深度学习在自然语言处理（NLP）中的应用：开启语言理解的新纪元】

文章目录 前言深度学习在NLP中的关键应用文本分类示例：使用深度学习模型分析代码结论 前言 自然语言处理（NLP）是人工智能领域中一个极具挑战性的分支，它旨在使计算机能够理解和生成人类语言。随着深度学习技术的兴起，NLP领域经历了革命性的变化，特别是在语言模型、机器翻译、情感分析和问答系统等方面。本篇博客将探讨深度学习在NLP中的关键应用，并通过一个简单的文本分类示例，
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2