自己动手写Java String类

Posted 2020-11-18 shizongger

很早想造个轮子了，听说不想造轮子的程序员不是好程序员，用惯了Apache的众多开源项目，却没看过开源一句代码。最近看了几篇卖焦虑的文章之后，突然变得慌张起来，于是在百忙之中难得一点闲第一次打开了JDK的源码包。初读：晦涩难懂，3千多行代码，全英文注释，有一些陌生的语法和调用陌生的类足矣吓退一个中年程序员。再度：只读个轮廓，这String.class也就是注释写的全写得多，核心代码不多嘛！三读：哇喔，整个String类核心变量就一个char[]数组嘛:

private final char value[];

一切的操作都是这这个value[]这个核心变量来做拼接concat()，截取subString()，判断是否存在indexOf(),startWith()的。慢点：想到这，似乎想起了大学时候某门熟悉的课程，对，就是《数据结构与算法》，这门隐隐约约，渐行渐远，慢慢淡出了我的世界之后，似乎又派上用场了。说实话，大学的时候只学过一学期的数据结构，以C语言为描述和实现的，这门课在我考完试的时候就被抛弃了，从此以为不会再用到。但是今天想自己实现一个String类，得重新回忆，好在虽然年纪已经向中年大叔迈进，但那几分记忆力还是有的，于是乎就写着写着，把String类的基本操作方法都实现了一遍，由于人家JDK已经有一个完美版的String类了，自己写的就叫做MyString吧。你只需要知道操作这个类类比于数据结构的ArrayList就行了，毕竟String的内容实现就是一数组嘛！
好吧，我知道你想说的是：Takl is clean,Show me the Code,直接上代码吧！

import java.io.Serializable;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.util.Arrays;
import java.util.Collections;
import java.util.Locale;

public class MyString implements Serializable, Comparable<String>, CharSequence {
    
    private static final long serialVersionUID = -204188373852348874L;
    
    /**
     * 定义char型数组,核心变量
     */
    private final char[] value;
    
    /**
     * 空构造函数
     */
    public MyString() {
        value = new char[0];
    }
    
    /**
     * @param str 默认String值的构造方法
     */
    public MyString(String str) {
        this.value = str.toCharArray();
    }
    
    public MyString(char[] value) {
        this.value = value;
    }
    public MyString(byte[] bytes) {
         this.value = new char[bytes.length];
         for(int i = 0; i < bytes.length; i++) {
             this.value[i] = (char) bytes[i];
         }
    }
    public MyString(char value[], int offset, int count) {
        if(offset < 0) {
            throw new StringIndexOutOfBoundsException(offset);
        }
        if(count <= 0) {
            if(count < 0) {
                throw new StringIndexOutOfBoundsException(count);
            }
            if(offset <= value.length) {
                this.value = new char[0];
                return;
            }
        }
        if(offset > value.length-count) {
            throw new StringIndexOutOfBoundsException(offset);
        }
        this.value = Arrays.copyOfRange(value, offset, count);
    }

    
    @Override
    public int length() {
        return value.length;
    }

    @Override
    public char charAt(int index) {
        if(index > this.value.length || index < 0) {
            throw new StringIndexOutOfBoundsException(index);
        }
        return this.value[index];
    }

    @Override
    public CharSequence subSequence(int start, int end) {
        if(start < 0) {
            throw new StringIndexOutOfBoundsException(start);
        }
        if(end > value.length) {
            throw new StringIndexOutOfBoundsException(end);
        }
        if(start > end) {
            throw new StringIndexOutOfBoundsException("start index is bigger than end index.");
        }
        
        MyString result = new MyString(Arrays.copyOfRange(value, start, end));
        return result;
    }

    @Override
    public int compareTo(String o) {
        return 0;
    }
    
    public int compareTo(MyString anotherString) {
        if(this == anotherString) {
            return 0;
        }
        
        return 0;
    }
    
    @Override
    public String toString() {
        return new String(this.value);
    }
    
    public boolean equals(Object anObject) {
        if(this == anObject) {
            return true;
        }
        if(anObject instanceof MyString) {
            MyString anString = (MyString)anObject;
            if(anString.length() == value.length) {
                char[] v1 = anString.value;
                char[] v2 = value;
                int n = v1.length;
                while(n-- != 0) {
                    if(v1[n] != v2[n]) {
                        return false;
                    }
                }
                return true;
            }
        }
        return false;
    }
    
    //TODO
    public boolean contains(CharSequence s) {
        
        return true;
    }
    
    public int indexOf(int ch) {
        return indexOf(0, ch);
    }
    
    public int indexOf(int ch, int fromIndex){
        for(int i = 0; i < value.length; i++) {
            if(value[i] == ch) {
                return i;
            }
        }
        return -1;
    }
    public int indexOf(MyString str) {
        return indexOf(str, 0);
    }
    
    public int indexOf(MyString str, int fromIndex){
        char[] source = value;
        char[] target = str.value;
        for(int i = fromIndex; i < source.length; i++) {
            if(source[i] == target[0]){
                int index = i;
                int sameLen = 1;
                for(int j = 1; j < target.length && (i+j) < source.length; j++) {
                    if(target[j] != source[i+j]) {
                        break;
                    }
                    sameLen++;
                }
                if(sameLen == target.length) {
                    return index;
                }
            }
        }
        return -1;
    }
    
    public MyString concat(MyString str) {
        if(str.length() == 0) {
            return this;
        }
        int len = value.length;
        int otherLen = str.length();
        char[] buf = Arrays.copyOf(value, len + otherLen);  //定义一个新的char[]数组,长度为原数组+要拼接的数组长度，并将原来的数组内容复制到新的数组
        System.arraycopy(str.value, 0, buf, len, otherLen);
        return new MyString(buf);
    }
    
    public boolean startsWith(MyString prefix) {
        return this.startsWith(prefix, 0);
    }
    
    /**
     * 检测字符串是否以某子串开头
     * @param   prefix  子串
     * @param   toffset 字符串的起始位置
     * @return  {@code true} 如果字符串以该子串开头就返回true; {@code false} 否则返回false.
     * @since   1. 0
     * @author SpringChang
     */

    public boolean startsWith(MyString prefix, int toffset){
        char[] target = prefix.value;
        char[] source = value;
        int sameLen = 0; //相同字符长度
        for(int i = 0; i < target.length && (toffset+i) < source.length; i++) {
            if(source[toffset+i] != target[i]) {
                break;
            }
            sameLen++;
        }
        if(sameLen == target.length) {
            return true;
        }
        return false;
    }
    
    public MyString toLowerCase(){
        return this.toLowerCase(Locale.getDefault());
    }
    public MyString toLowerCase(Locale locale){
        if(locale == null) {
             throw new NullPointerException();
        }
        char[] newString = new char[value.length];
        for(int i = 0; i < value.length; i++) {
            if(value[i] >= ‘A‘ && value[i] <= ‘Z‘) {
                newString[i] = (char) (value[i] + 32);
            } else {
                newString[i] = value[i];
            }
        }
                
        return new MyString(newString);
    }
    
    public MyString toUpperCase(){
        return this.toUpperCase(Locale.getDefault());
    }
    public MyString toUpperCase(Locale locale) {
        if(locale == null) {
             throw new NullPointerException();
        }
        char[] newString = new char[value.length];
        for(int i = 0; i < value.length; i++) {
            if(value[i] >= ‘a‘ && value[i] <= ‘z‘) {
                newString[i] = (char) (value[i] - 32);
            } else {
                newString[i] = value[i];
            }
        }
                
        return new MyString(newString);     
    }
    
    public MyString substring(int beginIndex){
        if(beginIndex < 0) {
            throw new StringIndexOutOfBoundsException(beginIndex);
        }
        return beginIndex==0?this:new MyString(value, beginIndex, value.length-beginIndex);
    }
    public MyString substring(int beginIndex, int endIndex){
        if(beginIndex < 0) {
            throw new StringIndexOutOfBoundsException(beginIndex);
        }
        if(endIndex > value.length) {
            throw new StringIndexOutOfBoundsException(endIndex);
        }
        return beginIndex==0?this:new MyString(value, beginIndex, endIndex);
    }
    

    /**
     * 将字符串转换为字符数组
     * @return 新的字符数组，不能是原来的数组，否则用户可以操作和修改String内容,这样违反String final设计原则。
     */
    public char[] toCharArray() {
        //return this.value; 不能直接这样返回
        char[] charArr = new char[value.length];
        System.arraycopy(value, 0, charArr, 0, value.length);
        return charArr;
    }
}

上诉只是一个mini版的String类，能实现String的基本操作功能，并没有完全实现String的全部功能，造此轮子并非想在项目开发中用它替换掉JDK的String类，只是想知道，别人的轮子是怎么造出来的，我知道你在怀疑它是不是真的能够用的起来，下面是两个测试类的代码，看看JDK自带的String和手写的MyString类有分别输出结果吧。

测试JDK自带String的几个方法。

public class TestJDKString {

    public static void main(String[] args) {
        String str1 = new String("Hello Java,");
        String str2 = new String("Hello Java,");
        System.out.println("str1 str2 地址是否相等?" + (str1 == str2));      //等号判断字符串是否相等
        System.out.println("str1 str2内容是否相等?" + (str1.equals(str2))); //判断俩字符串内容是否相等
        
        String str3 = new String("Hello World,");
        System.out.println(str3.concat(str1)); //字符串拼接
        System.out.println(str3.concat(str1).concat(str2));//字符串连续拼接
        
        System.out.println(str3.startsWith("Hello")); //判断字符串是否已经Hello开头
        System.out.println(str3.startsWith("Hello1")); //判断字符串是否已经Hello1开发
        
        System.out.println(new String("字符串变小写:I am a Java Programmer. I Love Java").toLowerCase()); //字符串变小写
        System.out.println(new String("字符串变大写写:I am a Java Programmer. I Love Java").toUpperCase());//字符串变大写
    }

}

输出结果:

str1 str2 地址是否相等?false
str1 str2内容是否相等?true
Hello World,Hello Java,
Hello World,Hello Java,Hello Java,
true
false
字符串变小写:i am a java programmer. i love java
字符串变大写写:I AM A JAVA PROGRAMMER. I LOVE JAVA

测试自己手写的MyString类的几个方法。

public class TestMyString {

    public static void main(String[] args) {
        MyString str1 = new MyString("Hello Java,");
        MyString str2 = new MyString("Hello Java,");
        System.out.println("str1 str2 地址是否相等?" + (str1 == str2));      //等号判断字符串是否相等
        System.out.println("str1 str2内容是否相等?" + (str1.equals(str2))); //判断俩字符串内容是否相等
        
        MyString str3 = new MyString("Hello World,");
        System.out.println(str3.concat(str1)); //字符串拼接
        System.out.println(str3.concat(str1).concat(str2));//字符串连续拼接
        
        System.out.println(str3.startsWith(new MyString("Hello"))); //判断字符串是否已经Hello开头
        System.out.println(str3.startsWith(new MyString("Hello1"))); //判断字符串是否已经Hello1开发
        
        
        System.out.println(new MyString("字符串变小写:I am a Java Programmer. I Love Java").toLowerCase()); //字符串变小写
        System.out.println(new MyString("字符串变大写写:I am a Java Programmer. I Love Java").toUpperCase());//字符串变大写
    }

}

输出结果:

str1 str2 地址是否相等?false
str1 str2内容是否相等?true
Hello World,Hello Java,
Hello World,Hello Java,Hello Java,
true
false
字符串变小写:i am a java programmer. i love java
字符串变大写写:I AM A JAVA PROGRAMMER. I LOVE JAVA