本教程将指导您如何在 Sealos DevBox 项目中使用 Java 语言连接和操作 Redis 数据库。我们将通过一个完整的示例项目，展示从环境配置到代码实现的全过程。

准备工作

在开始之前，请确保您已经：

项目配置

创建项目

首先，在 Sealos DevBox 终端中执行以下命令来初始化一个新的 Maven 项目：

mvn archetype:generate -DgroupId=com.example -DartifactId=redis-java-example -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false
mv redis-java-example/* .
rm -rf redis-java-example/

项目结构说明

完成配置后，您的项目将包含以下文件结构：

/
├── pom.xml
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │       └── example
│   │   │           ├── App.java
│   │   │           ├── RedisConfig.java
│   │   │           └── RedisConnection.java
│   │   └── resources
│   │       └── redis.properties
│   └── test
│       └── java
│           └── com
│               └── example
│                   └── AppTest.java

配置 pom.xml

请将项目的 pom.xml 文件内容更新为以下配置：

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
 
    <groupId>com.example</groupId>
    <artifactId>redis-java-example</artifactId>
    <version>1.0-SNAPSHOT</version>
 
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>
 
    <dependencies>
        <dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
            <version>4.3.1</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
            <version>2.0.5</version>
        </dependency>
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.4.12</version>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
            <scope>test</scope>
        </dependency>
    </dependencies>
 
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>11</source>
                    <target>11</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.4</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <transformers>
                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>com.example.App</mainClass>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

这个 pom.xml 配置文件主要包含：

Redis 客户端 Jedis 依赖
日志框架 SLF4J 依赖
Maven Shade 插件用于构建可执行 JAR 包

配置数据库连接

在 src/main/resources 目录下创建 redis.properties 配置文件：

redis.properties

redis.host=your_redis_host
redis.port=6379
redis.password=your_redis_password

请将配置文件中的占位符替换为您从 Sealos 数据库应用中获取的实际 Redis 连接信息。

编写 Java 代码

在 src/main/java/com/example 目录下，我们需要创建以下几个 Java 类：

App.java - 主程序类：此类用于演示 Redis 的基本操作，包括：

字符串的存取
列表的操作
哈希表的读写

App.java

package com.example;
 
import redis.clients.jedis.Jedis;
 
public class App {
    public static void main(String[] args) {
        try (Jedis jedis = RedisConnection.getConnection()) {
            System.out.println("Connected to Redis");
 
            // String operations
            jedis.set("mykey", "Hello from Sealos DevBox!");
            String value = jedis.get("mykey");
            System.out.println("Retrieved value: " + value);
 
            // List operations
            jedis.lpush("mylist", "element1", "element2", "element3");
            String listElement = jedis.lpop("mylist");
            System.out.println("Popped element from list: " + listElement);
 
            // Hash operations
            jedis.hset("myhash", "field1", "value1");
            jedis.hset("myhash", "field2", "value2");
            String hashValue = jedis.hget("myhash", "field1");
            System.out.println("Retrieved hash value: " + hashValue);
 
        } catch (Exception e) {
            System.err.println("Error connecting to Redis: " + e.getMessage());
        } finally {
            RedisConnection.closePool();
        }
    }
}

RedisConfig.java - 配置加载类：负责从 redis.properties 文件中读取并管理 Redis 连接配置

RedisConfig.java

package com.example;
 
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
 
public class RedisConfig {
    private static final Properties properties = new Properties();
 
    static {
        try (InputStream input = RedisConfig.class.getClassLoader().getResourceAsStream("redis.properties")) {
            if (input == null) {
                System.out.println("Sorry, unable to find redis.properties");
                System.exit(1);
            }
            properties.load(input);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
 
    public static String getHost() {
        return properties.getProperty("redis.host");
    }
 
    public static int getPort() {
        return Integer.parseInt(properties.getProperty("redis.port"));
    }
 
    public static String getPassword() {
        return properties.getProperty("redis.password");
    }
}

RedisConnection.java - 连接管理类：使用 Jedis 连接池管理 Redis 连接资源

RedisConnection.java

package com.example;
 
import redis.clients.jedis.Jedis;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
 
public class RedisConnection {
    private static final JedisPool pool = new JedisPool(new JedisPoolConfig(),
            RedisConfig.getHost(),
            RedisConfig.getPort(),
            2000,
            RedisConfig.getPassword());
 
    public static Jedis getConnection() {
        return pool.getResource();
    }
 
    public static void closePool() {
        pool.close();
    }
}

AppTest.java - 测试类：位于 src/test/java/com/example 目录

AppTest.java

package com.example;
 
import static org.junit.Assert.assertTrue;
 
import org.junit.Test;
 
public class AppTest 
{
    @Test
    public void shouldAnswerWithTrue()
    {
        assertTrue( true );
    }
}

构建与运行

在终端中执行以下命令来构建并运行项目：

mvn clean package
java -jar target/redis-java-example-1.0-SNAPSHOT.jar

如果配置正确，您将看到程序执行 Redis 操作的输出结果。

最佳实践

为确保项目的稳定性和可维护性，建议遵循以下最佳实践：

使用配置文件管理数据库连接信息，避免硬编码
实现专门的配置类处理属性文件的加载和访问
采用连接池模式提升性能并有效管理资源
确保正确关闭 Redis 连接 (推荐使用 try-with-resources 语法)
实现合理的异常处理机制和错误提示
使用 Maven 统一管理项目依赖和构建流程

常见问题排查

如果遇到连接问题，请按以下步骤排查：

检查 redis.properties 中的连接信息是否正确
确认 Redis 数据库服务是否正常运行，且可以从 DevBox 环境访问
检查 DevBox 环境的网络配置是否有限制
验证 pom.xml 中的 Jedis 依赖配置是否正确
确保使用的 Java 版本符合要求 (本示例使用 OpenJDK 17)

总结

本教程详细介绍了如何在 Sealos DevBox 环境中使用 Java 连接和操作 Redis 数据库。我们通过一个完整的示例项目，展示了从环境配置、代码实现到最终运行的全过程。同时提供了实用的开发建议和问题排查指南，帮助您快速构建可靠的 Java Redis 应用。

如需了解更多 Java Redis 开发相关内容，请参考 Jedis 官方文档。

Java