Introduction to Redisun

What is Redisun?

Redisun is a lightweight, high-performance Redis client based on smart-socket designed for the Java platform. It supports asynchronous non-blocking I/O operations and provides memory key-value storage access capabilities compatible with Redis servers.

💡 Core Features

• Lightweight Design: The core code consists of only a few classes, the jar package is only 33KB, and resource usage is minimal
• High-Performance Communication: Based on smart-socket Java AIO implementation, strong single-threaded processing capabilities, low resource consumption
• Connection Multiplexing Technology: Innovative connection multiplexing mechanism, one connection can handle multiple concurrent requests simultaneously
• RESP Protocol Support: Complete support for Redis Serialization Protocol (RESP), compatible with Redis servers

Basic Usage Example

Here is a simple usage example showing how to use Redisun for basic Redis operations:

import tech.smartboot.redisun.Redisun;

public class BasicExample {
    public static void main(String[] args) {
        // Create Redisun client instance
        Redisun redisun = Redisun.create(options ->
            options.setAddress("127.0.0.1:6379")  // Set Redis server address
                   .debug(true)                    // Enable debug mode
        );

        try {
            // Set key-value pair
            boolean setResult = redisun.set("hello", "world");
            System.out.println("SET operation result: " + setResult);

            // Get key value
            String getResult = redisun.get("hello");
            System.out.println("GET operation result: " + getResult);

            // Delete key
            int delResult = redisun.del("hello");
            System.out.println("DEL operation result: " + delResult);
        } finally {
            // Close client, release resources
            redisun.close();
        }
    }
}

More Operation Examples

Redisun also supports more Redis commands, such as sorted set operations:

// Add elements to sorted set
int zaddResult = redisun.zadd("myzset", 1.0, "member1");
System.out.println("ZADD operation result: " + zaddResult);

// Optional parameter settings
boolean setResultWithOptions = redisun.set("key", "value", cmd ->
    cmd.expire(60)              // Set 60-second expiration
       .setIfNotExists()        // Set only if key does not exist
);
System.out.println("SET operation with options result: " + setResultWithOptions);

Through these examples, you can see that Redisun’s API design is simple and intuitive, making it easy to integrate into your projects.

Redis Command Support Status

Redisun is continuously expanding support for Redis commands. Here is the current command implementation status:

✅ Fully Supported Commands

Command	Description	Implementation Class	Notes
HELLO	Server handshake and authentication	HelloCommand	Supports authentication and protocol negotiation
SET	Set key-value pairs	SetCommand	Complete option support: NX, XX, EX, PX, PXAT, KEEPTTL
GET	Get the value of a key	GetCommand	Basic key-value retrieval
DEL	Delete one or more keys	DelCommand	Supports multi-key deletion
ZADD	Add members to sorted set	ZAddCommand	Basic sorted set member addition
SELECT	Switch database	SelectCommand	Only executed during initial connection, does not support runtime switching
DBSIZE	Return the number of keys in the current database	DBSizeCommand	Count keys in current database
FLUSHALL	Clear all databases	FlushAllCommand	Delete keys from all databases
FLUSHDB	Clear current database	FlushDbCommand	Clear current database
EXISTS	Check if key exists	ExistsCommand	Check if one or more keys exist
INCR	Increment the integer value of a key by one	IncrCommand	Atomic increment operation
DECR	Decrement the integer value of a key by one	DecrCommand	Atomic decrement operation
APPEND	Append a value to a key	AppendCommand	String append operation
STRLEN	Get the length of a key’s value	StrlenCommand	String length operation
HSET	Set the string value of a hash field	HSetCommand	Hash field set operation
HGET	Get the value of a hash field	HGetCommand	Hash field get operation
SADD	Add one or more members to a set	SAddCommand	Set member add operation
INCRBY	Increment the integer value of a key by the given number	IncrByCommand	Atomic increment operation
DECRBY	Decrement the integer value of a key by the given number	DecrByCommand	Atomic decrement operation
MGET	Get the values of all given keys	MGetCommand	Get multiple key values
MSET	Set multiple key-value pairs	MSetCommand	Set multiple key-value pairs
EXPIRE	Set a timeout on a key	ExpireCommand	Supports NX, XX, GT, LT options
TTL	Get the time to live for a key	TtlCommand	Returns the remaining lifetime of a key in seconds
TYPE	Determine the type stored at a key	TypeCommand	Returns the type stored at a key
LPUSH	Insert elements at the head of a list	LPushCommand	Insert one or more elements at the head of a list
RPUSH	Insert elements at the tail of a list	RPushCommand	Insert one or more elements at the tail of a list
LPOP	Remove and return the first element of a list	LPopCommand	Remove and return the first element of a list
RPOP	Remove and return the last element of a list	RPopCommand	Remove and return the last element of a list
ZREM	Remove members from a sorted set	ZRemCommand	Remove one or more members from a sorted set
ZRANGE	Return a range of members in a sorted set	ZRangeCommand	Return members in a specified index range of a sorted set
ZSCORE	Get the score associated with the given member in a sorted set	ZScoreCommand	Get the score of a specified member in a sorted set

🚧 Commands In Progress/Planned

We are actively expanding Redis command support. More commands will be included in future versions.

🛠 Custom Command Extension

Redisun provides a powerful extension mechanism. You can easily implement custom Redis commands by extending the Command base class. This makes it simple to add support for any Redis commands not yet built into the library.

For detailed information on using custom commands to extend Redisun, please refer to our Extension Guide.