Guava:拯救垃圾代码,写出优雅高效,效率提升N倍

Guava的实用性太高了,所以借着转载加深理解了下guava的使用方式,后面会补充转载文章中未介绍的功能例如:RateLimiter等

Guava 项目是 Google 公司开源的 Java 核心库,它主要是包含一些在 Java 开发中经常使用到的功能,如数据校验、不可变集合、计数集合,集合增强操作、I/O、缓存、字符串操作等。并且 Guava 广泛用于 Google 内部的 Java 项目中,也被其他公司广泛使用,甚至在新版 JDK 中直接引入了 Guava 中的优秀类库,所以质量毋庸置疑。

使用方式直接 mavan 依赖引入。



    com.google.guava
    guava
    30.0-jre

数据校验

数据校验说来十分简单,一是非空判断,二是预期值判断。非空判断我想每一个 Java 开发者都很熟悉,一开始都经常和 NullPointException 打交道。处理的方式我们自然是一个if( xx == null) 就能轻松解决。预期值判断也是类似,检查数据值是不是自己想要的结果即可。

即使这么简单的操作,我们是不是还经常出错呢?而且写起来的代码总是一行判断一行异常抛出,怎么看都觉得那么优雅。还好,现在就来尝试第一次使用 Guava 吧。

String param2 = null;
String name2 = Preconditions.checkNotNull(param2,"param2 is null");
// java.lang.NullPointerException: param2 is null

预期值判断

和非空判断类似,可以比较当前值和预期值,如果不相等可以自定义报错信息抛出。

String param = "www.wdbyte.com2";
String wdbyte = "www.wdbyte.com";
Preconditions.checkArgument(wdbyte.equals(param), "[%s] 404 NOT FOUND", param);
// java.lang.IllegalArgumentException: [www.wdbyte.com2] 404 NOT FOUND

是否越界

// Guava 中快速创建ArrayList
List list = Lists.newArrayList("a", "b", "c", "d");
// 开始校验
int index = Preconditions.checkElementIndex(5, list.size());
// java.lang.IndexOutOfBoundsException: index (5) must be less than size (4)

代码中快速创建 List 的方式也是 Guava 提供的,后面会详细介绍 Guava 中集合创建的超多姿势。

不可变的集合

创建不可变集合是我个人最喜欢 Guava 的一个原因,因为创建一个不能删除、不能修改、不能增加元素的集合实在是太实用了。这样的集合你完全不用担心发生什么问题,总的来说有下面几个优点:

  • 1.线程安全,因为不能修改任何元素,可以随意多线程使用且没有并发问题。
  • 2.可以无忧的提供给第三方使用,反正修改不了。
  • 3.减少内存占用,因为不能改变,所以内部实现可以最大程度节约内存占用。
  • 4.可以用作常量集合。
// 创建方式1:of
ImmutableSet immutableSet = ImmutableSet.of("a", "b", "c");
immutableSet.forEach(System.out::println);
// a
// b
// c

// 创建方式2:builder
ImmutableSet immutableSet2 = ImmutableSet.builder()
    .add("hello")
    .add(new String("AAA"))
    .build();
immutableSet2.forEach(System.out::println);
// hello
// AAA

// 创建方式3:从其他集合中拷贝创建
ArrayList arrayList = new ArrayList();
arrayList.add("www.wdbyte.com");
arrayList.add("https");
ImmutableSet immutableSet3 = ImmutableSet.copyOf(arrayList);
immutableSet3.forEach(System.out::println);
// www.wdbyte.com
// https

都可以正常打印遍历结果,但是如果进行增删改,会直接报 UnsupportedOperationException .

其实 JDK 中也提供了一个不可变集合,可以像下面这样创建。

ArrayList arrayList = new ArrayList();
arrayList.add("www.wdbyte.com");
arrayList.add("https");
// JDK Collections 创建不可变 List
List list = Collections.unmodifiableList(arrayList);
list.forEach(System.out::println);// www.wdbyte.com https
list.add("AAA"); // java.lang.UnsupportedOperationException

注意事项

1.使用 Guava 创建的不可变集合是拒绝 null 值的,因为在 Google 内部调查中,95% 的情况下都不需要放入 null 值。
2.使用 JDK 提供的不可变集合创建成功后,原集合添加元素会体现在不可变集合中,而 Guava 的不可变集合不会有这个问题。

   List arrayList = new ArrayList<>();
   arrayList.add("a");
   arrayList.add("b");
   List jdkList = Collections.unmodifiableList(arrayList);
   ImmutableList immutableList = ImmutableList.copyOf(arrayList);
   arrayList.add("ccc");
   jdkList.forEach(System.out::println);// result: a b ccc
   System.out.println("-------");
   immutableList.forEach(System.out::println);// result: a b

3.如果不可变集合的元素是引用对象,那么引用对象的属性是可以更改的。

其他不可变集合不可变集合除了上面演示的 set 之外,还有很多不可变集合,下面是 Guava 中不可变集合和其他集合的对应关系。


image.png

集合操作工厂

其实这里只会介绍一个创建方法,但是为什么还是单独拿出来介绍了呢?看下去你就会大呼好用。虽然 JDK 中已经提供了大量的集合相关的操作方法,用起来也是非常的方便,但是 Guava 还是增加了一些十分好用的方法,保证让你用上一次就爱不释手,创建集合。

// 创建一个 ArrayList 集合
List list1 = Lists.newArrayList();
// 创建一个 ArrayList 集合,同时塞入3个数据
List list2 = Lists.newArrayList("a", "b", "c");
// 创建一个 ArrayList 集合,容量初始化为10
List list3 = Lists.newArrayListWithCapacity(10);
LinkedList linkedList1 = Lists.newLinkedList();
CopyOnWriteArrayList cowArrayList = Lists.newCopyOnWriteArrayList();
HashMap hashMap = Maps.newHashMap();
ConcurrentMap concurrentMap = Maps.newConcurrentMap();
TreeMap treeMap = Maps.newTreeMap();
HashSet hashSet = Sets.newHashSet();
HashSet newHashSet = Sets.newHashSet("a", "a", "b", "c");
 
 

集合交集并集差集

Set newHashSet1 = Sets.newHashSet("a", "a", "b", "c");
Set newHashSet2 = Sets.newHashSet("b", "b", "c", "d");
// 交集
SetView intersectionSet = Sets.intersection(newHashSet1, newHashSet2);
System.out.println(intersectionSet); // [b, c]
// 并集
SetView unionSet = Sets.union(newHashSet1, newHashSet2);
System.out.println(unionSet); // [a, b, c, d]
// newHashSet1 中存在,newHashSet2 中不存在
SetView setView = Sets.difference(newHashSet1, newHashSet2);
System.out.println(setView); // [a]

有数量的集合

这个真的太有用了,因为我们经常会需要设计可以计数的集合,或者 value 是 List 的 Map 集合,如果说你不太明白,看下面这段代码,是否某天夜里你也这样写过。

  1. 统计相同元素出现的次数(下面的代码我已经尽可能精简写法了)。JDK 原生写法:
   // Java 统计相同元素出现的次数。
   List words = Lists.newArrayList("a", "b", "c", "d", "a", "c");
   Map countMap = new HashMap();
   for (String word : words) {
       Integer count = countMap.get(word);
       count = (count == null) ? 1 : ++count;
       countMap.put(word, count);
   }
   countMap.forEach((k, v) -> System.out.println(k + ":" + v));
   /**
    * result:
    * a:2
    * b:1
    * c:2
    * d:1
    */

尽管已经尽量优化代码,代码量还是不少的,那么在 Guava 中有什么不一样呢?在 Guava. 中主要是使用 HashMultiset 类,看下面。

   ArrayList arrayList = Lists.newArrayList("a", "b", "c", "d", "a", "c");
   HashMultiset multiset = HashMultiset.create(arrayList);
   multiset.elementSet().forEach(s -> System.out.println(s + ":" + multiset.count(s)));
   /**
    * result:
    * a:2
    * b:1
    * c:2
    * d:1
    */

是的,只要把元素添加进去就行了,不用在乎是否重复,最后都可以使用 count 方法统计重复元素数量。看着舒服,写着优雅,HashMultiset 是 Guava 中实现的 Collection 类,可以轻松统计元素数量。

  1. 一对多,value 是 List 的 Map 集合。假设一个场景,需要把很多动物按照种类进行分类,我相信最后你会写出类似的代码。JDK 原生写法:
   HashMap> animalMap = new HashMap<>();
   HashSet dogSet = new HashSet<>();
   dogSet.add("旺财");
   dogSet.add("大黄");
   animalMap.put("狗", dogSet);
   HashSet catSet = new HashSet<>();
   catSet.add("加菲");
   catSet.add("汤姆");
   animalMap.put("猫", catSet);
   System.out.println(animalMap.get("猫")); // [加菲, 汤姆]

最后一行查询猫得到了猫类的 "加菲" 和 ”汤姆“。这个代码简直太繁琐了,如果使用 Guava 呢?

   // use guava
   HashMultimap multimap = HashMultimap.create();
   multimap.put("狗", "大黄");
   multimap.put("狗", "旺财");
   multimap.put("猫", "加菲");
   multimap.put("猫", "汤姆");
   System.out.println(multimap.get("猫")); // [加菲, 汤姆]

HashMultimap 可以扔进去重复的 key 值,最后获取时可以得到所有的 value 值,可以看到输出结果和 JDK 写法上是一样的,但是代码已经无比清爽。

字符串操作

作为开发中最长使用的数据类型,字符串操作的增强可以让开发更加高效。

字符拼接

JDK 8 中其实已经内置了字符串拼接方法,但是它只是简单的拼接,没有额外操作,比如过滤掉 null 元素,去除前后空格等。先看一下 JDK 8 中字符串拼接的几种方式。

// JDK 方式一
ArrayList list = Lists.newArrayList("a", "b", "c", null);
String join = String.join(",", list);
System.out.println(join); // a,b,c,null
// JDK 方式二
String result = list.stream().collect(Collectors.joining(","));
System.out.println(result); // a,b,c,null
// JDK 方式三
StringJoiner stringJoiner = new StringJoiner(",");
list.forEach(stringJoiner::add);
System.out.println(stringJoiner.toString()); // a,b,c,null

可以看到 null 值也被拼接到了字符串里,这有时候不是我们想要的,那么使用 Guava 有什么不一样呢?

ArrayList list = Lists.newArrayList("a", "b", "c", null);
String join = Joiner.on(",").skipNulls().join(list);
System.out.println(join); // a,b,c
String join1 = Joiner.on(",").useForNull("空值").join("旺财", "汤姆", "杰瑞", null);
System.out.println(join1); // 旺财,汤姆,杰瑞,空值

可以看到使用 skipNulls() 可以跳过空值,使用 useFornull(String) 可以为空值自定义显示文本

字符串分割

JDK 中是自带字符串分割的,我想你也一定用过,那就是 String 的 split 方法,但是这个方法有一个问题,就是如果最后一个元素为空,那么就会丢弃,奇怪的是第一个元素为空却不会丢弃,这就十分迷惑,下面通过一个例子演示这个问题。

String str = ",a,,b,";
String[] splitArr = str.split(",");
Arrays.stream(splitArr).forEach(System.out::println);
System.out.println("------");
/**
 *
 * a
 * 
 * b
 * ------
 */

Guava 提供了 Splitter 类,并且有一系列的操作方式可以直观的控制分割逻辑。

String str = ",a ,,b ,";
Iterable split = Splitter.on(",")
    .omitEmptyStrings() // 忽略空值
    .trimResults() // 过滤结果中的空白
    .split(str);
split.forEach(System.out::println);
/**
 * a
 * b
 */

缓存

在开发中我们可能需要使用小规模的缓存,来提高访问速度。这时引入专业的缓存中间件可能又觉得浪费。现在可以了, Guava 中提供了简单的缓存类,且可以根据预计容量、过期时间等自动过期已经添加的元素。即使这样我们也要预估好可能占用的内存空间,以防内存占用过多。现在看一下在 Guava 中缓存该怎么用。

@Test
public void testCache() throws ExecutionException, InterruptedException {

    CacheLoader cacheLoader = new CacheLoader() {
        // 如果找不到元素,会调用这里
        @Override
        public Animal load(String s) {
            return null;
        }
    };
    LoadingCache loadingCache = CacheBuilder.newBuilder()
        .maximumSize(1000) // 容量
        .expireAfterWrite(3, TimeUnit.SECONDS) // 过期时间
        .removalListener(new MyRemovalListener()) // 失效监听器
        .build(cacheLoader); //
    loadingCache.put("狗", new Animal("旺财", 1));
    loadingCache.put("猫", new Animal("汤姆", 3));
    loadingCache.put("狼", new Animal("灰太狼", 4));

    loadingCache.invalidate("猫"); // 手动失效

    Animal animal = loadingCache.get("狼");
    System.out.println(animal);
    Thread.sleep(4 * 1000);
    // 狼已经自动过去,获取为 null 值报错
    System.out.println(loadingCache.get("狼"));
    /**
     * key=猫,value=Animal{name='汤姆', age=3},reason=EXPLICIT
     * Animal{name='灰太狼', age=4}
     * key=狗,value=Animal{name='旺财', age=1},reason=EXPIRED
     * key=狼,value=Animal{name='灰太狼', age=4},reason=EXPIRED
     *
     * com.google.common.cache.CacheLoader$InvalidCacheLoadException: CacheLoader returned null for key 狼.
     */
}

/**
 * 缓存移除监听器
 */
class MyRemovalListener implements RemovalListener {

    @Override
    public void onRemoval(RemovalNotification notification) {
        String reason = String.format("key=%s,value=%s,reason=%s", notification.getKey(), notification.getValue(), notification.getCause());
        System.out.println(reason);
    }
}

class Animal {
    private String name;
    private Integer age;

    @Override
    public String toString() {
        return "Animal{" +
            "name='" + name + '\'' +
            ", age=" + age +
            '}';
    }

    public Animal(String name, Integer age) {
        this.name = name;
        this.age = age;
    }
}

这个例子中主要分为 CacheLoader、MyRemovalListener、LoadingCache。CacheLoader 中重写了 load 方法,这个方法会在查询缓存没有命中时被调用,我这里直接返回了 null,其实这样会在没有命中时抛出 CacheLoader returned null for key 异常信息。MyRemovalListener 作为缓存元素失效时的监听类,在有元素缓存失效时会自动调用 onRemoval 方法,这里需要注意的是这个方法是同步方法,如果这里耗时较长,会阻塞直到处理完成。LoadingCache 就是缓存的主要操作对象了,常用的就是其中的 put 和 get 方法了。

限流Guava-RateLimiter (持续更新中。。。)

请先查看:https://blog.csdn.net/justlpf/article/details/104473592

关于Grave RateLimiter的timeout如何设置

首先我们要了解rate和令牌的发放间隔的关系。在bursty平滑模式下,如果rate设置10,那么意味着每秒会发放10个令牌,也就是说每100ms发放一个令牌。

我们现在用的是令牌桶算法,如果上一秒没有请求到来,那么这一秒的令牌桶内就有10个现成的令牌可以取用,10个请求一起到的话也无需等待,用来应对突发的请求高峰。

timeout的合理设置与两个因素有关,一个是rate,另一个是服务本身的耗时。

比如:服务本身的耗时是200ms,rate设置为10,那么运气好的请求一进来就能获得令牌的话,它的整体耗时是200ms+0ms=200ms。如果是运气不好的请求进来,刚好令牌发光了,然后需要等待100ms才能获得令牌,那么它的整体耗时就是200ms+100ms=300ms。

当然,如果运气更不好的话,可能还要再等一个令牌发访周期,直到取得令牌或者等待timeout为止。

如果此时timeout设置为1000ms,那么我们可以看到服务的整体耗时会在200ms ~ 1200ms之间波动。

结论:如果rate设置小而并发高,则令牌等待的概率就会增加;如果再加上服务自身耗时短,则令牌等待的时间也会大概率超过服务本身的时间,我们认为这种情况需要通过合理设置timeout来优化。

一般来说,我们推荐timeout的值应该<=(服务本身耗时/2)。

上述例子中,服务自身耗时10ms,那么我们将timeout设置为5ms。如果遇到请求高峰而拿不到令牌,应该快速返回。这种情况下,服务的整体耗时就会在10ms ~ 15ms之间波动,属于合理范围。

本文转载自:https://www.jianshu.com/p/1d95f2d87c63
本文转载自:https://www.jianshu.com/p/8f548e469bbe
本文转载自:https://blog.csdn.net/justlpf/article/details/104473592
Github 地址是: https://github.com/google/guava
Demo learning: https://github.com/liuliuzo/grava_learning

你可能感兴趣的:(Guava:拯救垃圾代码,写出优雅高效,效率提升N倍)