Merge pull request #143 from Soar360/readme_english

更新英文文档

Readme.en.md

@@ -1,91 +1,102 @@
-# NewLife. Redis - redis client component
+# NewLife.Redis - Redis Client Component
 
-![GitHub top language](https://img.shields.io/github/languages/top/newlifex/newlife.redis?logo=github) ![GitHub License](https://img.shields.io/github/license/newlifex/newlife.redis?logo=github) ![Nuget Downloads](https://img.shields.io/nuget/dt/newlife.redis?logo=nuget) ![Nuget](https://img.shields.io/nuget/v/newlife.redis?logo=nuget) ![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/newlife.redis?label=dev%20nuget&logo=nuget)
+![GitHub top language](https://img.shields.io/github/languages/top/newlifex/newlife.redis?logo=github)
+![GitHub License](https://img.shields.io/github/license/newlifex/newlife.redis?logo=github)
+![Nuget Downloads](https://img.shields.io/nuget/dt/newlife.redis?logo=nuget)
+![Nuget](https://img.shields.io/nuget/v/newlife.redis?logo=nuget)
+![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/newlife.redis?label=dev%20nuget&logo=nuget)
 
-`NewLife.Redis` is a Redis client component targeting high-performance processing of big data real-time computations.  
-Redis protocol base implementation Redis/RedisClient is located in [X components](https://github.com/NewLifeX/X), this library for the extension of the implementation, mainly to increase the list structure, hash structure, queues and other advanced features.  
 
-Source : https://github.com/NewLifeX/NewLife.Redis
-Nuget: NewLife.Redis
+`NewLife.Redis` is a Redis client component designed for high-performance real-time big data processing.  
+The Redis protocol is implemented in the Redis/RedisClient located in the [X component](https://github.com/NewLifeX/X), and this library extends it with advanced features such as list structures, hash structures, and queues.
+
+Source: https://github.com/NewLifeX/NewLife.Redis  
+Nuget: NewLife.Redis  
 Tutorial: [https://newlifex.com/core/redis](https://newlifex.com/core/redis)
 
 ---
-### Characteristics
-* Widely used in ZTO big data real-time computing, more than 200 Redis instances have been working stably for more than a year, processing nearly 100 million parcels of data per day, with an average daily call volume of 8 billion times
-* Low latency, with Get/Set operations taking an average of 200 to 600 us (including round-trip network communications)
-* High throughput, with its own connection pool, supporting up to 1,000 concurrencies
-* High-performance, with support for binary serialization
+
+### Features
+* Widely used for real-time big data processing at ZTO since 2017. More than 200 Redis instances have been running stably for over a year, processing nearly 100 million package data entries daily, with 8 billion calls per day.
+* Low latency, with Get/Set operations averaging 200-600μs (including round-trip network communication).
+* High throughput with an in-built connection pool, supporting up to 100,000 concurrent connections.
+* High performance, supports binary serialization.
 
 ---
-### Redis experience sharing
-* Multi-instance deployment on Linux, where the number of instances is equal to the number of processors, and the maximum memory of each instance is directly localized to the physical memory of the machine, avoiding the bursting of the memory of a single instance
-* Store massive data (1 billion+) on multiple instances based on key hash (Crc16/Crc32) for exponential growth in read/write performance
-* Use binary serialization instead of the usual Json serialization
-* Rationalize the design of the Value size of each pair of Keys, including but not limited to the use of bulk acquisition, with the principle of keeping each network packet in the vicinity of 1.4k bytes to reduce the number of communications
-* Redis client Get/Set operations took an average of 200-600 us (including round-trip network communication), which was used as a reference to evaluate the network environment and Redis client components
-* Consolidation of a batch of commands using the pipeline Pipeline
-* The main performance bottlenecks in Redis are serialization, network bandwidth, and memory size, with processors also bottlenecking during abuse
-* Other searchable optimization techniques
-The above experience, derived from more than 300 instances of more than 4T space more than a year of stable work experience, and in accordance with the degree of importance of the ranking of the order, according to the needs of the scene can be used as appropriate! 
+
+### Redis Experience Sharing
+* Deploy multiple instances on Linux, with the number of instances equal to the number of processors. Each instance's maximum memory equals the physical memory of the machine to avoid memory overflow in a single instance.
+* Store massive data (over 1 billion entries) across multiple instances by hashing keys (Crc16/Crc32), greatly improving read and write performance.
+* Use binary serialization instead of common JSON serialization.
+* Design the size of each key-value pair carefully, including but not limited to batch retrievals. The goal is to keep each network packet around 1.4k bytes to reduce communication overhead.
+* Redis Get/Set operations average 200-600μs (including round-trip network communication). Use this as a benchmark to assess the network environment and Redis client components.
+* Use pipelining to combine a batch of commands.
+* Redis’s main performance bottlenecks are serialization, network bandwidth, and memory size. Excessive use can also cause processor bottlenecks.
+* Other optimizations can be explored.
+
+The above experiences come from over a year of stable operation with over 300 instances and more than 4TB of space, ordered by importance and should be applied as needed based on the scenario.
 
 ---
-### Recommended usage
-It is recommended to use the singleton pattern, Redis has an internal connection pool and supports multi-threaded concurrent access.
-``` csharp
+
+### Recommended Usage
+It is recommended to use the Singleton pattern. Redis internally uses a connection pool and supports multi-threaded concurrent access.
+```csharp
 public static class RedisHelper
 {
     /// <summary>
-    /// Redis Instance
+    /// Redis instance
     /// </summary>
-    public static FullRedis redisConnection=FullRedis.Create("server=127.0.0.1:6379;password=123456;db=4");
+    public static FullRedis redisConnection { get; set; } = new FullRedis("127.0.0.1:6379", "123456", 4);
 }
 
 Console.WriteLine(RedisHelper.redisConnection.Keys);
-```
+``` 
 
 ---
+
 ### Basic Redis
-Redis implements the standard protocols as well as basic string manipulation , the complete implementation of the independent open source project [NewLife.Redis](https://github.com/NewLifeX/NewLife.Redis) provides .  
-Adopting connection pooling and synchronous blocking architecture, it features ultra-low latency (200~600us) and ultra-high throughput.  
-It should be widely used in the real-time calculation of big data in the logistics industry, and has been verified by 10 billion calls per day.  
+The Redis implementation follows the standard protocol and basic string operations, with the complete implementation provided by the independent open-source project [NewLife.Redis](https://github.com/NewLifeX/NewLife.Redis).  
+It uses a connection pool and synchronous blocking architecture, offering ultra-low latency (200-600μs) and extremely high throughput.  
+It is widely used in real-time big data processing in the logistics industry and has been validated with daily call volumes of 10 billion.
 
-```csharp 
-// Instantiate Redis, the default port 6379 can be omitted, and the password can be written in two ways
+```csharp
+// Instantiate Redis, default port 6379 can be omitted, two ways to write the password
 //var rds = new FullRedis("127.0.0.1", null, 7);
 var rds = new FullRedis("127.0.0.1:6379", "pass", 7);
 //var rds = new FullRedis();
 //rds.Init("server=127.0.0.1:6379;password=pass;db=7");
-rds.Log = XTrace.Log; // Debug log. Comments for formal use
+rds.Log = XTrace.Log;
 ```
 
-### Basic operations
-Before the basic operation, let's do some preparation:
-+ Create a new console project and add `XTrace.UseConsole();` at the beginning of the entry function to make it easier to view the debug logs.
-+ Before you can test the code, you need to add the code that instantiates MemoryCache or Redis.
-+ Prepare a model class User
-
-``` csharp
+### Basic Operations
+Before performing basic operations, we need to do some preparation:
++ Create a new console project and add `XTrace.UseConsole();` at the beginning of the main function to easily view debug logs.
++ Before testing specific code, ensure you have instantiated either MemoryCache or Redis.
++ Prepare a model class `User`:
+```csharp
 class User
 {
     public String Name { get; set; }
     public DateTime CreateTime { get; set; }
 }
 ```
 
-Add, delete and check:
-``` csharp
+Add, Delete, Update, Query:
+```csharp
 var rds = new FullRedis("127.0.0.1", null, 7);
+rds.Log = XTrace.Log;
+rds.ClientLog = XTrace.Log; // Debug log. Comment out for production use.
 var user = new User { Name = "NewLife", CreateTime = DateTime.Now };
 rds.Set("user", user, 3600);
 var user2 = rds.Get<User>("user");
 XTrace.WriteLine("Json: {0}", user2.ToJson());
 XTrace.WriteLine("Json: {0}", rds.Get<String>("user"));
-if (rds.ContainsKey("user")) XTrace.WriteLine("exists!");
+if (rds.ContainsKey("user")) XTrace.WriteLine("Exists!");
 rds.Remove("user");
-``` 
+```
 
-Implementation results:
-``` csharp
+Execution Result:
+```csharp
 14:14:25.990  1 N - SELECT 7
 14:14:25.992  1 N - => OK
 14:14:26.008  1 N - SETEX user 3600 [53]
@@ -97,20 +108,22 @@ Implementation results:
 14:14:26.066  1 N - Json: {"Name":"NewLife","CreateTime":"2018-09-25 14:14:25"}
 14:14:26.067  1 N - EXISTS user
 14:14:26.068  1 N - => 1
-14:14:26.068  1 N - 存在！
+14:14:26.068  1 N - Exists!
 14:14:26.069  1 N - DEL user
 14:14:26.070  1 N - => 1
-``` 
+```
 
-When saving complex objects, Json serialization is used by default, so above you can get the results back by string and find exactly the Json string.  
-Redis strings are, essentially, binary data with a length prefix; [53] represents a 53-byte length piece of binary data. 
+When saving complex objects, the default serialization method is JSON. Therefore, when retrieving the result as a string, you'll find it is in JSON format.  
+Redis strings are essentially binary data with length prefixes, where [53] indicates 53 bytes of binary data.
 
-### Collection operations
-GetAll/SetAll is a very common batch operation on Redis to get or set multiple keys at the same time, typically with 10x more throughput.   
+### Collection Operations
+GetAll/SetAll are commonly used batch operations in Redis, allowing you to get or set multiple keys simultaneously, often achieving more than 10x throughput.
 
-Batch operation:
-``` csharp
+Batch operations:
+```csharp
 var rds = new FullRedis("127.0.0.1", null, 7);
+rds.Log = XTrace.Log;
+rds.ClientLog = XTrace.Log; // Debug log. Comment out for production use.
 var dic = new Dictionary<String, Object>
 {
     ["name"] = "NewLife",
@@ -121,67 +134,86 @@ rds.SetAll(dic, 120);
 
 var vs = rds.GetAll<String>(dic.Keys);
 XTrace.WriteLine(vs.Join(",", e => $"{e.Key}={e.Value}"));
-``` 
+```
 
-Implementation results:
-``` csharp
+Execution Result:
+```csharp
 MSET name NewLife time 2018-09-25 15:56:26 count 1234
 => OK
 EXPIRE name 120
 EXPIRE time 120
 EXPIRE count 120
 MGET name time count
 name=NewLife,time=2018-09-25 15:56:26,count=1234
-``` 
+```
 
-There are also `GetList/GetDictionary/GetQueue/GetSet` four types of collections inside the set operation, which represent Redis lists, hashes, queues, Set collections, and so on.  
-The base version of Redis does not support these four collections, the full version [NewLife.Redis](https://github.com/NewLifeX/NewLife.Redis) does, and MemoryCache supports them directly.  
+In collection operations, there are also `GetList/GetDictionary/GetQueue/GetSet` for various types of collections like Redis lists, hashes, queues, and sets.  
+The basic Redis version does not support these collections, but the full version [NewLife.Redis](https://github.com/NewLifeX/NewLife.Redis) does, while MemoryCache directly supports them.
 
-### Advanced operations
-+ Add Adds the key when it does not exist, and returns false when it already exists.
-+ Replace Replacement replaces the existing value with the new value and returns the old value.  
-+ Increment Accumulation, atomic operation
-+ Decrement, atomic operation
+### Advanced Operations
++ Add: Adds a key if it does not exist, returns false if the key already exists.  
++ Replace: Replaces an existing value with a new value and returns the old value.  
++ Increment: Increments a value atomically.  
++ Decrement: Decrements a value atomically.
 
-Advanced Operations:
-``` csharp
+Advanced operations:
+```csharp
 var rds = new FullRedis("127.0.0.1", null, 7);
+rds.Log = XTrace.Log;
+rds.ClientLog = XTrace.Log; // Debug log. Comment out for production use.
 var flag = rds.Add("count", 5678);
-XTrace.WriteLine(flag ? "Add Success" : "Add Failure");
+XTrace.WriteLine(flag ? "Add Success" : "Add Failed");
 var ori = rds.Replace("count", 777);
 var count = rds.Get<Int32>("count");
-XTrace.WriteLine("count replaced by {0} with {1}", ori, count);
+XTrace.WriteLine("count changed from {0} to {1}", ori, count);
 
 rds.Increment("count", 11);
 var count2 = rds.Decrement("count", 10);
 XTrace.WriteLine("count={0}", count2);
-``` 
+```
 
-Implementation results:
-``` csharp
+Execution Result:
+```csharp
 SETNX count 5678
 => 0
-Add failed
+Add Failed
 GETSET count 777
 => 1234
 GET count
 => 777
-Replace count with 777 instead of 1234
+count changed from 1234 to 777
 INCRBY count 11
 => 788
 DECRBY count 10
 => 778
 count=778
-``` 
+```
+
+---
+
+### Performance Testing
+
+The **Bench** tool will perform pressure testing by dividing the workload into multiple groups based on the number of threads.  
+Parameters:
+- **rand**: Whether to randomly generate keys/values.
+- **batch**: Batch size, which optimizes read/write operations using GetAll/SetAll.
+
+By default, Redis sets **AutoPipeline=100**, meaning it automatically pipelines operations for better performance during read and write operations when there’s no batching.
+
+---
+
+### Redis's Siblings
+
+Redis implements the **ICache** interface, with its sibling, **MemoryCache**, being an in-memory cache with a throughput in the tens of millions.  
+It is highly recommended to design applications using the **ICache** interface. Use **MemoryCache** for small data, and when the data grows (to 100,000 entries), switch to **Redis** without needing to modify the business logic code.
+
+### Redis Server Support
 
-### Performance testing
-Bench conducts stress tests on additions, deletions, and modifications in multiple groups based on the number of threads.    
-rand parameter, whether to generate random key/value.
-batch Batch size, perform read and write operations in batches, optimized with GetAll/SetAll.  
+1. **Version 3.2 and above**:  
+   From version 3.2 onwards, **FullRedis** supports all Redis versions.
 
-Redis sets AutoPipeline=100 by default to turn on pipeline operations when there is no batching, optimized for add/delete.  
+2. **Stream Data Type**:  
+   FullRedis supports the **Stream** data type, which was introduced in Redis 5.0, allowing the storage and manipulation of message streams.
 
-### Siblings of Redis ###
-Redis implements the ICache interface, its twin MemoryCache, an in-memory cache with a ten million throughput rate.  
-Each application is strongly recommended to use ICache interface coding design and MemoryCache implementation for small data;
-After the data increase (100,000), switch to Redis implementation without modifying the business code.
+3. **LUA Not Supported**:  
+   FullRedis **does not support** LUA scripting, meaning you cannot execute Lua scripts through this client.