STL—string类—模拟实现

时间:2024-07-18 22:20:56

STL—string类—模拟实现

熟悉了string的结构和各自接口的使用之后,现在就要尝试去模拟实现string类

这个string类为了避免和我们库里的string类冲突,因此我们需要定义一个自己的命名空间

namespace wzf
{
	class string
    {
    public:
		//成员函数
    private:
    	//成员变量    
    }
}

成员变量:

		// 我们说string类其实是一个字符数组
		char* _str; // 这个指针指向的字符串可能来自各个地方,栈区、堆区、代码段(常量区)、数据段(静态区)
		size_t _size; // 表示有效字符的个数
		size_t _capacity; // 表示空间的大小还能存多少个有效字符
		static size_t npos; // 静态成员只能在类外定义

1.构造函数和析构函数

在这里我们先来看一个代码

string s("hello");

这里的hello是处于代码段(常量区)的,是常量,不可以改变的,是const char* 类型。但是我们string类是有很多接口是可以修改字符串的,因此我们的string类中需要存放一个指针去指向这个字符串,并且这个字符串不能是在代码段的,我们需要将其拷贝到堆区,这里空间大,并且我们可以操控。

  • 构造函数&拷贝构造函数

image-20240709184245124

拷贝构造函数一定要自己去实现,不然就会调用系统的默认拷贝构造的函数,系统做的就是浅拷贝,就是一个字节一个字节的复制过去,那么两个string对象的_str指针指向的是同一个地址,那么在析构函数就会程序崩溃,因为对同一个地址的空间释放了两次。

因此关于拷贝构造我们需要自己实现,这样就可以实现深拷贝

如果一个类中涉及到资源的管理,其拷贝构造函数、赋值运算符重载以及析构函数必须要显式给出。一般情况都是按照深拷贝方式提供。

image-20240709184555338

熟悉了深拷贝的概念,我们来看看拷贝构造和赋值运算符的深拷贝思路

深拷贝思路:

image-20240710123219425

image-20240710123346571

//string()
//	:_str(new char[1]) // 初始化列表
//{
//	_str[0] = '\0'; // 尽管没有有效字符,但是需要一个\0
//}

//string(char* str)
//	:_str(new char[strlen(str) + 1]) // +1是为了给\0留一个空间
//{
//	strcpy(_str, str);
//}

//对于上面的两个构造函数来说,他构成了默认构造函数,有没有参数都能处理
// 但是在c++来说,这种可以用全缺省来让代码更合理一些
		string(const char* str = "") // 如果str没有参数,那么默认是"",空字符串,只有一个'\0'。
		{
			// str不能是nullptr,不然strlen函数会对其解引用,那么就会报错。
			if (str == nullptr)
			{
				assert(false);
				return;
			}
			_size = strlen(str);
			_capacity = _size;
			_str = new char[_capacity + 1]; // + 1是为了存下'\0'
			strcpy(_str, str); // 把str指向的字符串复制到堆区,方便我们进行操作
			// 也可以用memcpy
			//memcpy(_str, str, strlen(str));// strlen(str)就代表着要拷贝的字节
		}

		string(const string& s)
			:_str(new char[s._capacity + 1])
			,_size(s._size)
			,_capacity(s._capacity)
		{
			//this->_size = s._size; // 这个this指针加不加都行,不加编译器帮你加
			//this->_capacity = s._capacity;
			strcpy(_str, s._str);
		}

拷贝构造的string(const string& s)中的形参一定得是引用&,不然就会陷入无限递归构造。具体原因和过程我在之前博客的面向对象中的拷贝构造有详细解析

类和对象(中)-****博客在这篇博客的拷贝构造内容中有讲述无穷递归的详解

  • 析构函数:

我们的string是动态开辟的数组,因此我们需要通过析构函数来释放其空间,不然会造成内存泄漏

	// 析构函数
	~string()
	{
		delete[] _str;
		_str = nullptr;
	}

2.赋值运算符重载

	// 赋值运算符重载
	string& operator=(const string& s) 
	{
		// 首先判断是否是自己给自己赋值,虽然过程不会报错,但是是无用的消耗
		if (this != &s) // 这里的&s是s的地址,要注意
		{
			delete[] _str; // 释放旧空间,不然会造成内存泄漏
			_str = new char[s._capacity + 1]; // 指向新开辟的空间
			_size = s._size;
			_capacity = s._capacity;
			strcpy(_str, s._str); // 再把要赋值的内容拷贝到新开辟的空间
		}

		return *this; // 返回值是为了支持连等号
	}

3.[]运算符重载

char& operator[](size_t i) const
	{
		assert(i < _size && i >= 0);

		return _str[i];
	}

this指针指向的对象如果不需要改变,那么我们通常会加const修饰

4.size()接口实现

size_t size() const
{
	return strlen(_str);
}

5.capacity()接口实现

size_t capacity() const
	{
		return _capacity;
	}

6.重载<<和>>(输入/输出符)

  • 重载<<输出符

要想重载<<,我们需要用到友元,具体原因可以复习之前的友元的学习。

想要访问s中的成员,需要声明友元friend ostream& operator<<(ostream& out, const string& s);

	// 重载<<运算符
	ostream& operator<<(ostream& out, const string& s)
	{
		out << s._str;

		return out;
	}

当然,也有不需要友元的用法,可以用for循环

	ostream& operator<<(ostream& out, const string& s)
	{
		for (int i = 0; s.size(); i++)
		{
			out << s[i];
		}

		return out;
	}

当然,这样的话,我们就需要我们的size接口和[]运算符重载的this指针,都要被const修饰

  • 重载>>输入符号

同样也是需要用到友元

friend istream& operator>>(istream& in, string& s);

	// 重载 >>运算符
	istream& operator>>(istream& in, string& s)
	{
		cout << "输入字符串" << endl;
		char str[999]; 
		in >> str;

		delete[] s._str; // 释放旧空间
		s._size = strlen(str);
		s._capacity = s._size;
		s._str = new char[s._capacity + 1]; // 开辟新空间
		strcpy(s._str, str); // 将栈区的内容拷贝都堆区的新空间上

		return in;
	}

但是这个写法有一个缺点,那就是str[999];一旦输入的字符超过999个,那么就会出问题。

优化后的写法:

这个写法需要实现+=

istream& operator>>(istream& in, string& s)
{
	while (1)
	{
		char ch;
		//in >> ch; // 不能用这个,因为当输入' '或者'\n'的时候,ch无法接收到
		ch = in.get();
		if (ch == ' ' || ch == '\n')
		{
			break;
		}
		else
		{
			s += ch;
		}

	}

	return in;
}

7.迭代器实现

在讲述迭代器实现之前,我们得先知道迭代器是干什么的,其实迭代器对于string来说就是一个方便去遍历它的东西。

而我们说遍历string类通常就有三种方式

  1. [] + for
  2. 迭代器
  3. 范围for循环

迭代器的实现:

	// 迭代器的实现
	typedef char* iterator; // 在string类中是指针,但是迭代器不一定都是指针,在链表就不是指针

	iterator begin()
	{
		return _str;
	}

	iterator end()
	{
		// 返回的是指向\0的位置
		return _str + _size;
	}

要注意:迭代器在string类中,我们可以将其理解成指针,但是迭代器不一定是指针。

测试代码:

	void test_string4()
	{
		cout << "test_string4: " << endl;
		// 遍历string的三种方式([], 迭代器,范围for)

		string s("hello");
		// 第一种遍历方式
		for (int i = 0; i < s.size(); i++)
		{
			cout << s[i];
		}
		cout << endl;

		// 第二种遍历方式——迭代器
		string::iterator it = s.begin1();
		while (it != s.end())
		{
			cout << *it;
			it++;
		}
		cout << endl;

		// 第三种遍历方式——范围for
		// 范围for是由迭代器支持的,最终会被编译器替换成迭代器去 
		for (auto e : s)
		{
			cout << e;
		}
		cout << endl;

	}

范围for循环,本身是由迭代器去支持的,怎么证明呢?

其实我们把迭代器的begin改个名,范围for就会报错了。如图所示。

image-20240711182030074

对于范围for来说,它需要一个迭代器,iterator,并且还需要这个迭代器能支持 begin(),end()。

增删查改类的接口实现

1.reserve()

		// reserve实现增容
		void reserve(size_t n)
		{
			if (n > _capacity) // 当n大于容量时才需要扩容
			{
				char* tmp = new char[n + 1]; // + 1是留给\0这个无效字符的。
				strcpy(tmp, _str);
				delete[] _str;// 释放旧的空间 
				_str = tmp; // 指向新的空间

				_capacity = n;// 更新_capacity成员
			}
		}

2.resize()

resize一共分3种情况:

  1. n < _size
  2. n > _size && n < _capacity
  3. n > _size && n > _capacity
	void resize(size_t n, char ch = '\0')
	{
        assert(n >= 0);
		// 一共3种情况分类讨论。
		if (n < _size)
		{
			// 将_size减小到n
			_size = n;

			_str[n] = '\0'; // 因为有效字符个数是n个,第二个字符之后的数据都不重要了
		}
		else
		{
			// 除了保留原数据,要把_size增大到n,原数据不够n的都填充ch字符
			if (n > _capacity) // 如果n大于能存的空间就要扩容
			{
				reserve(n); // 扩容到n
			}

			// 除了原数据,在n个有效字符(下标n-1)之前,都要填充ch字符
			for (int i = _size; i < n; i++)
			{
				_str[i] = ch;
			}
			_size = n;
			_str[_size] = '\0'; // 补充\0
		}
	}

3.push_back()

在c++中string类的push_back实现的是尾插字符,就是单个的字符

	void push_back(char ch)
	{
		// 先判断空间是否足够添加一个字符,不够的话要进行增容
		if (_size == _capacity)
		{
			size_t newcapacity = _capacity == 0 ? 5 : _capacity * 2;
			reserve(newcapacity);
		}

		// 尾插ch字符
		_str[_size] = ch;
		++_size;
		_str[_size] = '\0';
	}

要注意手动的给有效字符的最后+一个’\0’。尽管strcpy也会把’\0’拷贝到。但是后面我们尾插ch字符的时候将其覆盖了,因此我们需要手动补充。

4.append()

在c++中string类的append实现的是字符串的尾插

要注意其扩容的逻辑和push_back是不太一样的。

		void append(const char* str)
		{
			// append接口需要考虑当前容量是否能装下新增的字符串
			size_t len = strlen(str);
			if (_size + len > _capacity)
			{
				size_t newcapacity = _size + len;
				reserve(newcapacity);
			}

			// 尾插字符串
			strcpy(_str + _size, str); // str被拷贝到_str后边的时候,str自带\0,因此这里不需要我们手动插入\0了
			_size += len;
		}

		void append(const string& s)
		{
			size_t len = s._size;
			if (_size + len > _capacity)
			{
				size_t newcapacity = _size + len;
				reserve(newcapacity);
			}

			strcpy(_str + _size, s._str);
			_size += len;
		}

5.+=

我们在实际使用中append和push_back我们都不太喜欢用,我们最喜欢用的就是**+=**。

因为+=无论是单个字符还是字符串还是string类对象都可以使用。

	string& operator+=(char ch)
	{
		// 实现+=
		push_back(ch);// 等价于this->push_back(ch);

		return *this;
	}

	string& operator+=(const char* str)
	{
		// 实现+=
		append(str);// 等价于this->append(str);

		return *this;
	}

	string& operator+=(const string& s)
	{
		append(s);

		return *this;
	}

6.insert()

insert实现在具体位置插入字符和字符串

  • insert单个字符
		string& insert(size_t pos, char ch)
		{
			assert(pos <= _size && pos >= 0);
			if (_size == _capacity)
			{
				size_t newcapacity = _capacity + 1; //只插入一个ch字符
				reserve(newcapacity);
			}

			// 将pos位置开始,整体往后移动一位,再在pos位置插入ch
			int end = _size;
			// 从后往前移动,防止数据被覆盖丢失
			while (end >= pos && end >= 0) // 这里一定要有end>=0。不然当pos=0的时候会死循环(注意)
				// 当 end = 0时进入循环完成最后一次后移数据,本应--为-1,
				// 但是int类型在-1的二进制补码,在pos(size_t)看来,就是一个很大的正数,自然死循环
			{
				_str[end + 1] = _str[end];
				end--;
			}
			_str[pos] = ch; // 插入ch字符

			_size++;
			//_str[_size] = '\0'; // 补充被覆盖的0

			return *this;
		}

while (end >= pos && end >= 0)要注意end >=0一定要有

当 end = 0时进入循环完成最后一次后移数据,end本应–为-1,然后退出循环。但是int类型在0的时候–变成了一个很大的正数了,因此无法变成-1,自然死循环。

这是为什么呢?因为判断是否退出循环的条件是end >= pos,而pos我们知道又是size-t类型。也就是无符号的int类型,因此int为-1的二进制补码在size_t看来就是一个非常大的正数,因为size_t没有符号位。

看两个例子

	int i = 2;
	size_t pos = 0;
	while (i >= pos)
	{
		cout << "n" << endl;
		i--;
	}

这个代码的结果是死循环

	int i = 2;
	int pos = 0;
	while (i >= pos)
	{
		cout << "n" << endl;
		i--;
	}

而这个代码的结果就不是死循环。

image-20240714161428935

关于这个问题可以复习c语言中数据在内存的存储

数据在内存中的存储-****博客

  • insert字符串
		string& insert(size_t pos, const char* str)
		{
			assert(pos <= _size && pos >= 0);
			// 考虑当前的_capacity是否能够装下新增的字符串
			size_t len = strlen(str);
			if (_size + len > _capacity)
			{
				size_t newcapacity = _size + len;
				reserve(newcapacity);
			}

			// 扩容之后要先将pos位置后的数据后移len个长度
			int end = _size; //从\0开始移动,这样后面不用处理\0的问题
			while (end >= pos && end >= 0)
			{
				_str[end + len] = _str[end]; // 后移len个长度
				end--;
			}

			//从pos位置插入str字符串
			/*
			int k = 0;
			for (int i = pos; i < pos + len; i++)
			{
				_str[i] = str[k];
				k++;
			}*/
			strncpy(_str + pos, str, len); // 由于不想拷\0,用strncpy只拷len个长度
			_size += len; // 更新_size

			return *this;
		}

7.erase()

同样的erase也需要分类讨论

  1. _size - pos <= len,说明pos位置之后的元素要被全部删除
  2. _size - pos > len 说明pos + len位置之后的数据要往pos位置覆盖
void erase(size_t pos, size_t len = npos)
{
	assert(pos >= 0 && pos < _size);
	// 分两种情况
	if (_size - pos <= len)
	{
		// 这种情况就说明pos后面的有效字符小于等于要删除的字符数
		_str[pos] = '\0'; // 直接让pos位置为\0就行
		_size = pos; // 更新_size
	}
	else
	{
		// 删不完要把剩余属于往pos位置移动
		for (int i = pos + len; i <= _size; i++) //pos + len 就是剩余数据的第一个数据
		{
			_str[i - len] = _str[i]; // 向前移动len个长度
		}
		_size -= len; // 更新_size

	}
}

8.find

  • 找字符
	size_t find(char ch, size_t pos = 0)
	{
		for (int i = pos; i < _size; i++)
		{
			if (_str[i] == ch)
				return i; // 找到了返回下标位置
		}

		return npos;
	}
  • 找字符串
	size_t find(const char* str, size_t pos = 0)
	{
		char* p = strstr(_str, str); // 这个也可以自己实现,这里用库里的
		if (p == nullptr)
		{
			return npos;
		}
		else
		{
			// 要判断是否找的是pos位置之后的str
			if (p - _str < pos)
			{
				p = strstr(_str + pos, str);
				return p - _str;
			}

			// 如果是pos位置之后的那直接返回其下标
			return p - _str; // 返回字符串首元素的下标
		}
	}

运算符重载

运算符重载比较简单,实现了< 和 == 的重载之后,其他运算符都可以用代码复用来实现

		// 运算符重载
		bool operator<(const string& s)
		{
			// strcmp,第一个参数比第二个参数大那就返回1
			int ret = strcmp(_str, s._str);

			return ret < 0;
		}

		bool operator==(const string& s)
		{
			int ret = strcmp(_str, s._str);

			return ret == 0;
		}

		bool operator<=(const string& s)
		{
			return *this < s || *this == s;
		}

		bool operator>(const string& s)
		{
			return !(*this <= s);
		}

		bool operator>=(const string& s)
		{
			return *this > s || *this == s;
		}
		
		bool operator!=(const string& s)
		{
			return