跳至主要內容

基础工具类 - String&Ints


String相关工具

Strings

Guava 提供了一系列用于字符串处理的工具:

对字符串为null或空的处理

  1. nullToEmpty(@Nullable String string):如果非空,则返回给定的字符串;否则返回空字符串

    public static String nullToEmpty(@Nullable String string) {
        //如果string为null则返回空字符串,否则返回给定的string
        return string == null ? "" : string;
    }
    
  2. .isNullOrEmpty(@Nullable String string):如果字符串为空或长度为0返回true,否则返回false

    public static boolean isNullOrEmpty(@Nullable String string) {
        return string == null || string.length() == 0;
    }
    
  3. emptyToNull(@Nullable String string):如果非空,则返回给定的字符串;否则返回null

    public static String emptyToNull(@Nullable String string) {
        //调用isNullOrEmpty方法,如果返回true则return null,否则返回原字符串
        return isNullOrEmpty(string)?null:string;
    }
    

生成指定字符串的字符串副本

  1. padStart(String string, int minLength, char padChar):根据传入的minLength进行补充,如果minLength小于原来字符串的长度,则直接返回原来字符串,否则在字符串开头添加string.length() - minLength个padChar字符

    public static String padStart(String string, int minLength, char padChar) {
        //使用Preconditions工具类进行字符串验空处理   
        Preconditions.checkNotNull(string);
        //如果原字符串长度大于传入的新长度则直接返回原字符串
        if(string.length() >= minLength) {
            return string;
        } else { //否则
            StringBuilder sb = new StringBuilder(minLength);
            //先在字符串前面添加string.length()-minLength个padChar字符
            for(int i = string.length(); i < minLength; ++i) {
                sb.append(padChar);
            }
            //最后将原始字符串添加到尾部
            sb.append(string);
            return sb.toString();
        }
    }
    
  2. padEnd(String string, int minLength, char padChar):根据传入的minLength进行补充,如果minLength小于原来字符串的长度,则直接返回原来字符串,否则在字符串结尾添加 string.length() - minLength 个padChar字符

    public static String padEnd(String string, int minLength, char padChar) {
        Preconditions.checkNotNull(string);   
        //如果原字符串长度大于传入的新长度则直接返回原字符串
        if(string.length() >= minLength) {
            return string;
        } else {
            StringBuilder sb = new StringBuilder(minLength);
            //先将原始字符串添加到预生成的字符串当中
            sb.append(string);
            //在使用padChar进行填补
            for(int i = string.length(); i < minLength; ++i) {
                sb.append(padChar);
            }
            return sb.toString();
        }
    }
    
  3. repeat(String string, int count):返回count个 string字符串拼接成的字符串

    public static String repeat(String string, int count) {
        Preconditions.checkNotNull(string);
        //如果小于1,则抛出异常
        if(count <= 1) {
            Preconditions.checkArgument(count >= 0, "invalid count: %s", new Object[]{Integer.valueOf(count)});
            return count == 0 ? "":string;
        } else {
            int len = string.length();
            long longSize = (long)len * (long)count;
            int size = (int)longSize;
            //如果新创建的字符串长度超出int最大值,则抛出需要的数组过长的异常
            if((long)size != longSize) {
                throw new ArrayIndexOutOfBoundsException((new StringBuilder(51)).append("Required array size too large: ").append(longSize).toString());
            } else {
                //实际上新建一个相当长度的字符数组,再将数据复制进去
                char[] array = new char[size];
                //将string从0开始len结束之间的字符串复制到array数组中,且array数组从0开始存储
                string.getChars(0, len, array, 0);
                int n;
                //复制数组,复制的步长为(1,2,4...n^2),所以这快提供了一个外层循环为ln2的算法
                for(n = len; n < size - n; n <<= 1) {
                    System.arraycopy(array, 0, array, n, n);
                }
                System.arraycopy(array, 0, array, n, size - n);
                return new String(array);
            }
        }
    }
    

查找两个字符串的公共前缀或后缀

在看commonPrefix和commonSuffix 这两个方法之前需要先看下validSurrogatePairAt方法

static boolean validSurrogatePairAt(CharSequence string, int index) {
    return index >= 0 && index <= string.length() - 2 && Character.isHighSurrogate(string.charAt(index)) && Character.isLowSurrogate(string.charAt(index + 1));
}

这个方法的作用是 判断最后两个字符是不是合法的“Java 平台增补字符

  • Character.isHighSurrogate:确定给定char值是否为Unicode高位代理。这个值并不代表字符本身,而是在UTF-16编码的补充的字符的表示被使用。
  • Character.isLowSurrogate:确定给定char值是否为一个Unicode低代理项代码单元(也称为尾部代理项代码单元)。这些值并不代表本身的字符,但用于表示增补字符的UTF-16编码。

简单的说就是Java 语言内部的字符信息是使用 UTF-16 编码。因为char 这个类型是 16 bit 的。它可以有65536种取值,即65536个编号,每个编号可以代表1种字符。而在Unicode字符集中,有一些字符的编码超出了16 bit的范围,也就是超过了char类型能够直接表示的范围,65536 就不够用。

为了能够在Java中表示这些字符,Unicode引入了一种叫做“代理对”(Surrogate Pair)的机制。从这65536个编号里,拿出2048个,规定它们是「Surrogates」,让它们两个为一组,来代表编号大于65536的那些字符。 更具体地,编号为 D800 至 DBFF 的规定为「High Surrogates」,共1024个。编号为 DC00至 DFFF 的规定为「Low Surrogates」,也是1024个。它们两两组合出现,就又可以多表示1048576种字符。

如果丢失一个高位代理Surrogates或者低位代理Surrogates,就会出现乱码。这就是为什么emoji会出现乱码了。例如输入了一个emoji:😆,假如可以写成这样:\uD83D\uDC34

String s = '\uD83D' + '\uDC34' + "";

那么在按字节截取s的时候,就要考虑这个字符是不是高位代理Surrogates或者低位代理Surrogates,避免出现半个字符。

  1. commonPrefix(CharSequence a, CharSequece b):返回a和b两个字符串的公共前缀

    public static String commonPrefix(CharSequence a, CharSequence b) {
        Preconditions.checkNotNull(a);
        Preconditions.checkNotNull(b);
        //将字符串a和字符串b两个中短的字符串长度赋值给maxPrefixLength
        int maxPrefixLength = Math.min(a.length(), b.length());
        int p;
        //遍历直到第一个两个字符不相等的位置,找出公共的前缀
        for(p = 0; p < maxPrefixLength && a.charAt(p) == b.charAt(p); ++p) {
            ;
        }
         //特殊情况:当最后一个匹配的字符是一个UTF-16编码的代理对的一部分时,需要把指针向前移动一位,以避免在返回结果时切断代理对,因为这将产生无效的Unicode序列
        if(validSurrogatePairAt(a, p - 1) || validSurrogatePairAt(b, p - 1)) {
            --p;
        }
        return a.subSequence(0, p).toString();
    }
    
  2. commonSuffix(CharSequence a, CharSequence b):返回字符串a和字符串b的公共后缀

    public static String commonSuffix(CharSequence a, CharSequence b) {
        Preconditions.checkNotNull(a);
        Preconditions.checkNotNull(b);
        //将字符串a和字符串b两个中短的字符串长度赋值给maxPrefixLength
        int maxSuffixLength = Math.min(a.length(), b.length());
        int s;
        //遍历直到第一个两个字符不相等的位置,找出公共的后缀
        for(s = 0; s < maxSuffixLength && a.charAt(a.length() - s - 1) == b.charAt(b.length() - s - 1); ++s) {
            ;
        }
        if(validSurrogatePairAt(a, a.length() - s - 1) || validSurrogatePairAt(b, b.length() - s - 1)) {
            --s;
        }
        return a.subSequence(a.length() - s, a.length()).toString();
    }
    

Joiner

将字符串数组按指定分隔符连接起来,或字符串串按指定索引开始使用指定分隔符连接起来,创建的都是不可变实例,所以是线程安全的

底层实际是在用StringBuilder进行拼接操作。

使用案例

Joiner joiner = Joiner.on(";").useForNull("^");
// "A;B;^;D"
String joined = joiner.join("A", "B", null, "D");

静态创建Joiner

// 静态创建Joiner方法
public static Joiner on(String separator) {
    return new Joiner(separator);
}
 
public static Joiner on(char separator) {
    return new Joiner(String.valueOf(separator));
}

这两个方法一个传入字符串,一个传入字符,然后直接分别使用两个构造器构造

join()方法

对于4个join方法实际可以分为两类,一类是join实现类,另一类是join解析参数类

  1. 解析参数类:
//1. 因为 Iterable是所有集合类的顶级接口(除了Map系列),所以此参数为集合类或实现Iterable的类即可
public final String join(Iterable<?> parts) {
     //调用join实现类
     return this.join((Iterator)parts.iterator());
}
 
//2. 传入数组
public final String join(Object[] parts) {
     //将数组转为ArrayList然后强转为Iterable  
     return this.join((Iterable)Arrays.asList(parts));
}
 
//3. 传入两个参数和一个数组,最终这两个参数个数组一起构成一个新的数组
public final String join(@Nullable Object first, @Nullable Object second, Object... rest) {
     //使用iterable方法将参数和数组融合成一个数组
     return this.join((Iterable)iterable(first, second, rest));
}

第3个实现方法需要 iterable方法对数组进行融合,所以看一下 iterable的实现方式:

private static Iterable<Object> iterable(final Object first, final Object second, final Object[] rest) {
    Preconditions.checkNotNull(rest);
    //返回一个AbstractList对象,并且这个对象重写了size和get方法
    return new AbstractList() {
        //使得当前容量比rest数组多2个
        public int size() {
        return rest.length + 2;
    }
 
    public Object get(int index) {
        switch(index) {
            case 0:
                return first;
            case 1:
                return second;
           default:
               return rest[index - 2];
        }
    }};  
}
  1. join实现类
public final String join(Iterator<?> parts) {
     //实际使用appendTo(StringBuilder,Iterator)方法
     return this.appendTo((StringBuilder)(new StringBuilder()), (Iterator)parts).toString();
}
 
public final StringBuilder appendTo(StringBuilder builder, Iterator<?> parts) {
     try {
         //调用了appendTo(A, Iterator)方法
         this.appendTo((Appendable)builder, (Iterator)parts);
         return builder;
     } catch (IOException var4) {
         throw new AssertionError(var4);
     }
}
 
public <A extends Appendable> A appendTo(A appendable, Iterator<?> parts) throws IOException {  
     Preconditions.checkNotNull(appendable);
     if(parts.hasNext()) {
         //如果第一个迭代器存在,将其添加到出传入的StringBuilder中
         appendable.append(this.toString(parts.next()));
         //从第二个迭代器开始就会循环方式就会发生变化,每个元素前都会添加规定的分隔符
         while(parts.hasNext()) {
             appendable.append(this.separator);
             appendable.append(this.toString(parts.next()));
         }
     }
     return appendable;
}
 

useForNull方法

将传入的字符串代替集合中的null输出

public Joiner useForNull(final String nullText) {
    Preconditions.checkNotNull(nullText);
    // 返回一个Joiner重写了toString方法,将null的参数由 传入的nullText代替。
    return new Joiner(this, null) {
        CharSequence toString(@Nullable Object part) {
            return (CharSequence)(part == null ? nullText:Joiner.this.toString(part));
        }
 
        public Joiner useForNull(String nullTextx) {
            throw new UnsupportedOperationException("already specified useForNull");
        }
 
        public Joiner skipNulls() {
            throw new UnsupportedOperationException("already specified useForNull");
        }
    };
}

使用 useForNull方法后由于重写了useForNull和skipNulls方法,并且在两个方法中都抛出了异常。所以不能再次调用这两个方法。

注意:空字符串"" 无法命中这个方法,从源码中也可以看出来

skipNulls方法

自动跳过null元素进行拼接

public Joiner skipNulls() {
    //返回一个Joiner,重写了appendTo方法,跳过null
    return new Joiner(this, null) {
        public <A extends Appendable> A appendTo(A appendable, Iterator<?> parts) throws IOException {
            Preconditions.checkNotNull(appendable, "appendable");
            Preconditions.checkNotNull(parts, "parts");
            Object part;
            // 与 原始appendTo方法不同的就是 多了 part != null 的判断语句
            while(parts.hasNext()) {
                part = parts.next();
                if(part != null) {
                    appendable.append(Joiner.this.toString(part));
                    break;
                }
            }
            // 给上面添加的 part 拼接上连接符 separator 
            while(parts.hasNext()) {
                part = parts.next(); 
                if(part != null) {
                    appendable.append(Joiner.this.separator);
                    appendable.append(Joiner.this.toString(part));
                }
            }
            return appendable;
        }
 
        public Joiner useForNull(String nullText) {
            throw new UnsupportedOperationException("already specified skipNulls");
        }
 
        public Joiner.MapJoiner withKeyValueSeparator(String kvs) {
            throw new UnsupportedOperationException("can\'t use .skipNulls() with maps");
        }
    };
}

注意:空字符串"" 无法命中这个方法,从源码中也可以看出来

对Map解析的函数和类

public Joiner.MapJoiner withKeyValueSeparator(String keyValueSeparator) {
    return new Joiner.MapJoiner(this, keyValueSeparator, null);
}

可以看到这个函数返回的是Joiner中的一个内部类,这个类里的大多方法都是在处理Map连接的函数

MapJoiner中的join方法实际上是对Map的entrySet即可以的集合进行拼接。整体思路与上面一致

CharMatchers

字符序列匹配和处理的工具,内置了大量常用的匹配器。使用上通常分两步:

  • 确定匹配的字符和模式
  • 用匹配的字符做处理
// 确定匹配的字符和模式,例如 anyOf, none, whitespace, digit, javaLetter, javaIsoControl...
CharMatcher matcher = CharMatcher.anyOf("abc");
// defg
log.debug("{}", matcher.removeFrom("abcdefg"));
// abc
log.debug("{}", matcher.retainFrom("abcdefg"));
// true
log.debug("{}", matcher.matchesAllOf("abc"));
// hhh 
log.debug("{}", matcher.trimFrom("abchhhabc"));
// ___hhh___
log.debug("{}", matcher.replaceFrom("abc hhh abc", "_"));

实现类

实现类类作用
ANY匹配任何字符
ASCII匹配是否是ASCII字符
BREAKING_WHITESPACE匹配所有可换行的空白字符(不包括非换行空白字符,例如"\u00a0")
JAVA_ISO_CONTROL匹配ISO控制字符, 使用 Charater.isISOControl() 实现
NONE不匹配所有字符
WHITESPACE匹配所有空白字符

常用方法可分为4类:

得到匹配指定规则的Matcher

CharMatcher is(char match):返回匹配指定字符的Matcher
CharMatcher isNot(char match):返回不匹配指定字符的Matcher
CharMatcher anyOf(CharSequence sequence):返回匹配sequence中任意字符的Matcher
CharMatcher noneOf(CharSequence sequence):返回不匹配sequence中任何一个字符的Matcher
CharMatcher inRange(char startInclusive, char endInclusive):返回匹配范围内任意字符的Matcher
CharMatcher negate():返回当前Matcher相反的Matcher
CharMatcher and(CharMatcher other):返回与other匹配条件组合做与来判断Matcher,即取两个Matcher的交集
CharMatcher or(CharMatcher other):返回与other匹配条件组合做或来判断Matcher,即取两个Matcher的并集

判断字符串是否匹配

Boolean matchesAnyOf(CharSequence sequence):只要sequence中有任意字符能匹配Matcher,返回true
Boolean matchesAllOf(CharSequence sequence):sequence中所有字符能匹配Matcher,返回true
Boolean matchesNoneOf(CharSequence sequence):sequence中所有字符都不能匹配Matcher,返回true

获取字符串与Matcher匹配的位置信息

int indexIn(CharSequence sequence): 返回sequence中匹配到的第一个字符的坐标
int indexIn(CharSequence sequence, int start): 返回从start开始,在sequence中匹配到的第一个字符的坐标
int lastIndexIn(CharSequence sequence): 返回sequence中最后一次匹配到的字符的坐标
int countIn(CharSequence sequence): 返回sequence中匹配到的字符计数

对字符串进行怎样匹配处理

String removeFrom(CharSequence sequence): 删除sequence中匹配到到的字符并返回
String retainFrom(CharSequence sequence): 保留sequence中匹配到的字符并返回
String replaceFrom(CharSequence sequence, char replacement): 替换sequence中匹配到的字符并返回
String trimFrom(CharSequence sequence): 删除首尾匹配到的字符并返回
String trimLeadingFrom(CharSequence sequence): 删除首部匹配到的字符
String trimTrailingFrom(CharSequence sequence): 删除尾部匹配到的字符
String collapseFrom(CharSequence sequence, char replacement): 将匹配到的组(连续匹配的字符)替换成replacement
String trimAndCollapseFrom(CharSequence sequence, char replacement): 先trim在replace

Splitter

字符串分割工具,创建的也是不可变实例,所以是线程安全的

底层用的是 String的subString方法

使用案例

// String#split 反直觉的输出:["", "a", "", "b"]
Arrays.stream(",a,,b,".split(",")).toList().forEach(System.out::println);
// ["foo", "bar", "qux"]
Iterable<String> split = Splitter.on(",")
    	// 结果自动 trim
        .trimResults()
    	// 忽略结果中的空串
        .omitEmptyStrings()
        // 限制分割数
        .limit(3)
        .split("foo,bar,,   qux");
Map<String, String> splitMap = Splitter.on(";")
	// 指定 K-V 的分隔符可以将键值对的串解析为 Map
	.withKeyValueSeparator("->")
	.split("A->1;B->2");

两个内部类

在通读整片源码前先来了解其中的两个内部类,这两个内部类是真正去分解字符串的:

其中一个是 处理字符、字符串、正则的接口,此接口的定义实质为 策略模式

private interface Strategy {
    Iterator<String> iterator(Splitter var1, CharSequence var2);
}

这个接口中只有一个方法,返回的是一个Iterator迭代器,这里可以先联想到最终返回的集合的迭代器会与它有关系

这里实现了一个惰性迭代器:惰性迭代器就是指 直到不得不计算的时候才会去将字符串分割,即在迭代的时候才去分割字符串,无论将分隔符还是被分割的字符串加载到Splitter类中,都不会去分割,只有在迭代的时候才会真正的去分割

private abstract static class SplittingIterator extends AbstractIterator<String> {
    final CharSequence toSplit;
    final CharMatcher trimmer;
    final boolean omitEmptyStrings;
    int offset = 0;
    int limit;
    // 获取被分割字符串中第一个与分隔符匹配的位置
    abstract int separatorStart(int var1);
    // 获取当前分隔符在字符串中的结尾位置
    abstract int separatorEnd(int var1);
    // 构造函数,将当前的截取字符串信息赋值给SplittingIterator变量
    protected SplittingIterator(Splitter splitter, CharSequence toSplit) {
        this.trimmer = splitter.trimmer;
        this.omitEmptyStrings = splitter.omitEmptyStrings;
        this.limit = splitter.limit;
        this.toSplit = toSplit;
    }
 
    //重写迭代方法,就是这里实现的 惰性迭代器
    protected String computeNext() {
        int nextStart = this.offset;
        while(true) {
            while(this.offset != -1) {
                int start = nextStart;
                //根据separatorStart方法进行获取字符串中的第一个分隔符位置
                int separatorPosition = this.separatorStart(this.offset);
                int end;
                if(separatorPosition == -1) {
                    end = this.toSplit.length();
                    this.offset = -1;
                } else {
                    end = separatorPosition;
                    //根据separatorEnd方法进行获取字符串中的第一个分隔符的结束位置
                    this.offset = this.separatorEnd(separatorPosition);
                }
                if(this.offset != nextStart) {
                    while(start < end && this.trimmer.matches(this.toSplit.charAt(start))) {
                        ++start;
                    }
                    while(end > start && this.trimmer.matches(this.toSplit.charAt(end - 1))) {
                        --end;
                    }
                    //如果omitEmptyStrings为true,则对空结果跳过处理,否则进入
                    if(!this.omitEmptyStrings || start != end) {
                         //当规定的最多结果数值为1时,输出最后的所有字符串,然后结束迭代
                        if(this.limit == 1) {
                            end = this.toSplit.length();
                            for(this.offset = -1; end > start && this.trimmer.matches(this.toSplit.charAt(end - 1)); --end) {
                                ;
                            }
                        } else {
                            //没有到最后一个时,进行减1操作
                            --this.limit;
                        }
                        return this.toSplit.subSequence(start, end).toString();
                    }
                    nextStart = this.offset;
                } else {
                    ++this.offset;
                    if(this.offset > this.toSplit.length()) {
                        this.offset = -1;
                    }
                }
            }
            return (String)this.endOfData();
        }
    }
}

这是一个实现AbstractIterator的一个抽象类,实现了 computeNext方法(此方法可以在看集合源码的时候也多注意一下),这个方法实际上是规定了此迭代器的一个迭代规则。所以Splitter类为他分割完的结果集也写了一个迭代器并规定了自己的迭代规则。从这个迭代器的实现上,在结合Strategy 类便可以将整个字符串分割的过程给串起来了。

除了这两个,还有一个内部类是 MapSplitter,是用于处理Map,对Map进行分割的

变量

//移除指定字符项,即集合中当前元素与trimmer匹配,将其移除。如果没有设置trimmer,则将结果中的空格删除
//最终结论为:将结果集中的每个字符串前缀和后缀都去除trimmer,直到前缀或后缀没有这个字符了,字符串“中”的不用去除
private final CharMatcher trimmer;

//是否移除结果集中的空集,true为移除结果集中的空集,false为不用移除结果集中的空集
private final boolean omitEmptyStrings;

//这个变量最终会返回一个所有集合类的父接口,它是贯穿着整个字符串分解的变量
private final Splitter.Strategy strategy;

//最多将字符串分为几个集合,比如limit=3, 对”a,b,c,d”字符串进行','分割,返回的[”a”,”b”,”c,d”] 意思为最多可以分割成3段,这个可以在链式编程的limit方法参数设置
private final int limit;

静态创建Splitter

两个构造函数都是私有构造器,所以不能直接使用这两个构造器去创建Splitter,想要创建Splitter只能使用静态方法。

//接收 一个Strategy类对象
private Splitter(Splitter.Strategy strategy) {
    this(strategy, false, CharMatcher.NONE, 2147483647);
}
 
//此构造器为所有变量进行赋值
private Splitter(Splitter.Strategy strategy, boolean omitEmptyStrings, CharMatcher trimmer, int limit) {
    this.strategy = strategy;
    this.omitEmptyStrings = omitEmptyStrings;
    this.trimmer = trimmer;
    this.limit = limit;
}

静态创建Splitter函数有四种:

  1. 接收字符的构造器

    //接收一个字符的构造器,然后调用参数为 CharMatcher的构造器
    public static Splitter on(char separator) {
        return on((CharMatcher)CharMatcher.is(separator));
    }
     
    //接收一个CharMatcher的构造器
    public static Splitter on(final CharMatcher separatorMatcher) {
        //对字符判空
        Preconditions.checkNotNull(separatorMatcher);
        //返回一个Splitter对象,传入Strategy对象,并对Strategy接口进行实现
        return new Splitter(new Splitter.Strategy() {
            //实现接口Strategy的iterator方法
            public Splitter.SplittingIterator iterator(final Splitter splitter, final CharSequence toSplit) {
                //返回 SplittingIterator对象,并对 SplittingIterator 抽象类实现 separatorStart方法和 separatorEnd方法
                return new Splitter.SplittingIterator(splitter, toSplit) {
                    //返回从start 开始的第一个分隔符的开始位置
                    int separatorStart(int start) {
                        return separatorMatcher.indexIn(this.toSplit, start);
                    }
                    //返回当前分割符的末尾位置
                    int separatorEnd(int separatorPosition) {
                        return separatorPosition + 1;
                    }
                };
            }
        });
    }
    
  2. 接收字符串的构造器

    //传入一个字符串作为分隔符
    public static Splitter on(final String separator) {
        Preconditions.checkArgument(separator.length() != 0, "The separator may not be the empty string.");
        //如果当前字符串的长度为1,则直接调用解析单个字符的构造器上,否则会返回一个Splitter对象,传入Strategy对象,并对Strategy接口进行实现
        return separator.length() ==  1 ? on(separator.charAt(0)) : new Splitter(new Splitter.Strategy() {
            //实现Strategy接口
            public Splitter.SplittingIterator iterator(final Splitter splitter, final CharSequence toSplit) {
                return new Splitter.SplittingIterator(splitter, toSplit) {
                    //这个方法是被分割字符串从start开始,找到第一个分隔符的位置,没有找到返回-1
                    public int separatorStart(int start) {
                        //获取分割符长度
                        int separatorLength = separator.length();
                        //记录分割符开始位子
                        int p = start;
                        
                        label24:
                        //last是调用本类的 toSplit 变量即被分割的字符串长度,last取被分割的字符串长度与分割符的差值
                        //假设分割符号”,” 被分割字符串”a,b,c,d” last= 7-1 = 6
                        for(int last = this.toSplit.length() - separatorLength; p <= last; ++p) {
                            for(int i = 0; i < separatorLength; ++i) {
                                //找到匹配到分隔符的第一个位置
                                if (this.toSplit.charAt(i + p) != separator.charAt(i)) {
                                    continue label24;
                                }
                            }
                            return p;
                        }
                        return -1;
                    }
                    //传入分离器位置,返回分离器末尾位置
                    public int separatorEnd(int separatorPosition) {
                        return separatorPosition + separator.length();
                    }
                };
            }
        });
    }
    
  3. 接收正则表达式的构造器

    @GwtIncompatible用于指示某个类、方法或字段不兼容或不应被用于Google Web Toolkit (GWT)。GWT是一个开发工具,允许开发者编写Java代码,然后将这些代码编译成高效的JavaScript代码,以便在浏览器中运行。这个工具使得Java开发者可以编写前端代码,而不需要直接使用JavaScript。

    //传入一个字符串,返回一个调用传入CommonPattern类型的on方法
    @GwtIncompatible
    public static Splitter onPattern(String separatorPattern) {
        return on((CommonPattern)Platform.compilePattern(separatorPattern));
    }
     
    //传入一个Pattern类型参数,返回一个调用传入CommonPattern类型的on方法
    @GwtIncompatible
    public static Splitter on(Pattern separatorPattern) {
        return on((CommonPattern)(new JdkPattern(separatorPattern)));
    }
     
    //传入一个 CommonPattern类型的构造器
    private static Splitter on(final CommonPattern separatorPattern) {
        Preconditions.checkArgument(!separatorPattern.matcher("").matches(), "The pattern may not match the empty string: %s", separatorPattern);
        //返回一个Splitter对象,传入Strategy对象,并对Strategy接口进行实现
        return new Splitter(new Splitter.Strategy() {
            //实现Strategy对象的iterator方法
            public Splitter.SplittingIterator iterator(final Splitter splitter, final CharSequence toSplit) {
                final CommonMatcher matcher = separatorPattern.matcher(toSplit);
                return new Splitter.SplittingIterator(splitter, toSplit) {
                    //返回从start开始的第一个分隔符的开始位置
                    public int separatorStart(int start) {
                        return matcher.find(start)?matcher.start():-1;
                    }
                    //返回当前分割符的末尾位置
                    public int separatorEnd(int separatorPosition) {
                        return matcher.end();
                    }
                };
            }
        });
    }
    
  4. 按指定长度分割的构造器

    public static Splitter fixedLength(final int length) {
        Preconditions.checkArgument(length > 0, "The length may not be less than 1");
        return new Splitter(new Splitter.Strategy() {
            public Splitter.SplittingIterator iterator(final Splitter splitter, final CharSequence toSplit) {
                return new Splitter.SplittingIterator(splitter, toSplit) {
                    //按 length长度进行跨步
                    public int separatorStart(int start) {
                        int nextChunkStart = start + length;
                        return nextChunkStart < this.toSplit.length()?nextChunkStart:-1;
                    }
                    public int separatorEnd(int separatorPosition) {
                        return separatorPosition;
                    }
                };
            }
        });
    }
    

进行分割的函数 (split、splittingIterator)

  1. 返回值是 Iterable 的函数:

    public Iterable<String> split(final CharSequence sequence) {
        Preconditions.checkNotNull(sequence);
        //返回一个容器,然后重写了iterator和toString方法
        return new Iterable() {
            public Iterator<String> iterator() {
                //调用了 splittingIterator方法
                return Splitter.this.splittingIterator(sequence);
            }
     
            //重写了toString方法,将字符串用","隔开,并在前后用中括号包裹
            public String toString() {
                return Joiner.on(", ").appendTo((new StringBuilder()).append('['), this).append(']').toString();
            }
        };
    }
    
    private Iterator<String> splittingIterator(CharSequence sequence) {
        return this.strategy.iterator(this, sequence);
    }
    

    这里调用了Strategy的iterator方法,这个方法在 静态创建Splitter中 里面有多种的实现方法,再结合内部类中的 SplittingIterator类重写的迭代方法,这里就形成了一个特殊的容器返回。也就是说,真正的拆分字符串动作是在迭代的时候进行的,即在这个函数中进行的。

  2. 返回值是List对象的函数

    public List<String> splitToList(CharSequence sequence) {
        Preconditions.checkNotNull(sequence);
        Iterator iterator = this.splittingIterator(sequence);
        ArrayList result = new ArrayList();
        while(iterator.hasNext()) {
            result.add(iterator.next());
        }
        return Collections.unmodifiableList(result);
    }
    

    与上面一样是先调用了Strategy的iterator方法。再遍历将结果集放在了ArrayList容器中,再返回不可变的List。

其它功能性方法

  1. omitEmptyStrings方法:移去结果中的空字符串

    public Splitter omitEmptyStrings() {
        return new Splitter(this.strategy, true, this.trimmer, this.limit);
    }
    

    这里就是将omitEmptyStrings标记位改为true,在computeNext方法中进行输出操作时将空结果略过

  2. trimResults方法

    //未输入参数的情况下,默认是将结果中的空格删除
    public Splitter trimResults() {
        return this.trimResults(CharMatcher.whitespace());
    }
     
    //输入参数,则是移除指定字符
    public Splitter trimResults(CharMatcher trimmer) {
        Preconditions.checkNotNull(trimmer);
        return new Splitter(this.strategy, this.omitEmptyStrings, trimmer, this.limit);
    }
    

    调用此方法可以将结果集中的每个字符串前缀和后缀都去除trimmer,他的实现也是在computeNext方法中进行的

  3. limit方法:达到指定数目后停止字符串划分

    public Splitter limit(int limit) {
        Preconditions.checkArgument(limit > 0, "must be greater than zero: %s", limit);
        return new Splitter(this.strategy, this.omitEmptyStrings, this.trimmer, limit);
    }
    

    将传入的limit值赋值给变量

MapSpliter

Spliter和MapSpliter跟Joiner以及MapJoiner功能正好相反。

Map<String,String> maps = Maps.newHashMap();		
maps.put("id", "1");		
maps.put("name", "2");		

String ss= Joiner.on("&").withKeyValueSeparator("=").join(maps);		
maps =Splitter.on("&").withKeyValueSeparator("=").split(ss);

通用/其它工具

Preconditions

提供静态方法来检查方法或构造函数。如果方法失败则抛出 NullPointerException。

JDK 7 开始提供的 Objects 类也提供了一些类似的功能,具体可以参考 JDK Doc

对null的处理

public static <T> T checkNotNull(T reference)
public static <T> T checkNotNull(T reference, @Nullable Object errorMessage)
public static <T> T checkNotNull(T reference, @Nullable String errorMessageTemplate, @Nullable Object... errorMessageArgs)

根据三个方法的描述,reference是要进行判断的引用,接下来的信息是自定义异常打印信息

public static <T> T checkNotNull(T reference) {
    //如果引用为null,则直接抛出异常,如果不为null,则直接返回这个引用
    if(reference == null) {
        throw new NullPointerException();
    } else {
        return reference;
    }
}

对真假的处理

对真假的判断实现有两种实现函数checkArgument()和checkState()

public static void checkArgument(boolean expression) {
    if (!expression) {
        throw new IllegalArgumentException();
    }
}

public static void checkState(boolean expression) {
    if (!expression) {
        throw new IllegalStateException();
    }
}

两个函数的实现大体一致,都是对传入的boolean类型参数进行判断

如果为false

  • checkArgument方法会抛出IllegalArgumentException()
  • checkState方法会抛出IllegalStateException()

对数组下标是否符合的处理

对数组下标合格的判断有三种方法checkElementIndex()、checkPositionIndex()、checkPositionIndexs()

checkElementIndex(int index, int size):判断0 - size-1中是否存在index
checkPositionIndex(int index, int size):判断 0 - size 中是否存在index
checkPositionIndexs(int start, int end, int size):判断传入的start和end与size的顺序关系并且start和end是否在 0 ~ size 范围中
@CanIgnoreReturnValue
public static int checkElementIndex(int index, int size) {
    return checkElementIndex(index, size, "index");
}

@CanIgnoreReturnValue
public static int checkElementIndex(int index, int size, String desc) {
    if (index >= 0 && index < size) {
        return index;
    } else {
        throw new IndexOutOfBoundsException(badElementIndex(index, size, desc));
    }
}

Ints

  1. compare(int a, int b):比较两个指定的int值

    public static int compare(int a, int b) {
        return a < b ? -1 : (a > b ? 1 : 0);
    }
    
  2. asList(int... backingArray):返回由指定数组支持的固定大小的列表,类似Arrays.asList(Object[]).

    public static List<Integer> asList(int... backingArray) {
        return (List)(backingArray.length == 0?Collections.emptyList():new Ints.IntArrayAsList(backingArray));
    }
    

由源码可以看到,如果传入的参数长度为0,那么就会创建一个Collections.emptyList(),如果参数长度不为0,那么就会创建一个Ints的内部类IntArrayAsList。

特殊说明:Ints的asList与JDK的Arrays.asLis的不同点:

  • Arrays.asList(Object[])返回的是一个List<数组>,而Ints的asList返回的是List<Integer>。

  • Ints的asList返回的是内部的一个不可变的List,没有重写add方法,因此执行add操作会抛异常。

  1. contains(int[] array, int target):如果array中存在target返回true,反之返回false

    public static boolean contains(int[] array, int target) {
        int[] var2 = array;
        int var3 = array.length;
    
        for(int var4 = 0; var4 < var3; ++var4) {
            int value = var2[var4];
            //循环查找array中与target相等的元素,如果有相等的直接返回true
            if (value == target) {
                return true;
            }
       }
    
       return false;
    }
    

字符常量/大小写转换

  1. Charsets: 提供了6种标准的字符集常量引用,例如Charsets.UTF_8。JDK 7 以后建议使用内置的 StandardCharsets

  2. CaseFormat: 大小写转换的工具

// UPPER_UNDERSCORE -> LOWER_CAMEL
CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, "CONSTANT_NAME"));
FormatExample
LOWER_CAMELlowerCamel
LOWER_HYPHENlower-hyphen
LOWER_UNDERSCORElower_underscore
UPPER_CAMELUpperCamel
UPPER_UNDERSCOREUPPER_UNDERSCORE
seven97官方微信公众号
seven97官方微信公众号