如何基于用户偏好配置Spring管理的DocumentService Bean

这个场景我之前在项目里碰到过，核心矛盾是Spring默认的单例Bean无法适配每个用户的个性化存储配置——毕竟每个用户的S3密钥、Google存储JSON文件都是独有的。我们需要为每个用户动态生成对应的DocumentService实例，同时借助Spring的依赖注入能力管理这些实例。下面是具体的实现步骤：

1. 先定义用户存储配置的核心组件 #

首先，我们需要一个服务来获取当前用户的存储偏好，以及对应的配置参数：

1.1 定义用户存储配置POJO #

public enum StorageType {
    S3, GOOGLE_STORAGE
}

public class UserStorageConfig {
    private String userId;
    private StorageType storageType;
    // S3相关配置
    private String s3AccessKey;
    private String s3SecretKey;
    private String s3Region;
    // Google存储相关配置
    private String googleJsonFilePath;

    // 省略getter/setter
}

1.2 实现用户配置获取服务 #

这个服务负责从数据库/缓存中读取当前登录用户的存储配置：

@Service
public class UserStoragePreferenceService {
    // 假设从数据库查询配置，这里简化逻辑
    public UserStorageConfig getStorageConfigByUserId(String userId) {
        // 实际业务中根据userId查询DB/Redis
        return ...;
    }

    // 获取当前登录用户的配置
    public UserStorageConfig getCurrentUserStorageConfig() {
        String userId = getCurrentUserId();
        return getStorageConfigByUserId(userId);
    }

    private String getCurrentUserId() {
        Authentication auth = SecurityContextHolder.getContext().getAuthentication();
        if (auth == null || !auth.isAuthenticated()) {
            throw new IllegalStateException("用户未登录");
        }
        return auth.getName(); // 这里根据你的认证逻辑调整，比如返回用户ID
    }
}

2. 配置DocumentService实现类为原型Bean #

因为每个用户的实例配置不同，我们不能用单例，把实现类标记为@Scope("prototype")，这样Spring每次获取都会生成新实例：

@Scope("prototype")
@Component
public class AmazonS3DocumentService implements DocumentService {
    private AmazonS3 s3Client;
    // 可以注入其他Spring管理的依赖，比如日志、工具类
    private final Logger logger = LoggerFactory.getLogger(AmazonS3DocumentService.class);

    // 提供setter来注入用户专属的S3客户端
    public void setS3Client(AmazonS3 s3Client) {
        this.s3Client = s3Client;
    }

    @Override
    public void upload(MultipartFile file) {
        // 用s3Client实现上传逻辑
        logger.info("S3上传文件：{}", file.getOriginalFilename());
        // ...
    }

    @Override
    public void delete(String documentId) {
        // 实现删除逻辑
        // ...
    }
}

GoogleStorageDocumentService的写法类似，同样标记为原型Scope，提供setter注入Google Storage客户端。

3. 实现DocumentService工厂类 #

这个工厂是核心，负责根据用户配置动态创建并配置对应的DocumentService实例，同时加入缓存优化性能：

@Component
public class DocumentServiceFactory {
    private final UserStoragePreferenceService preferenceService;
    private final ApplicationContext applicationContext;
    // 用ConcurrentHashMap做线程安全的缓存，key是用户ID，value是对应的服务实例
    private final ConcurrentHashMap<String, DocumentService> userServiceCache = new ConcurrentHashMap<>();

    // 构造注入依赖
    public DocumentServiceFactory(UserStoragePreferenceService preferenceService, ApplicationContext applicationContext) {
        this.preferenceService = preferenceService;
        this.applicationContext = applicationContext;
    }

    // 获取当前用户的DocumentService
    public DocumentService getCurrentUserDocumentService() {
        String userId = getCurrentUserId();
        // 缓存不存在则创建，存在则复用
        return userServiceCache.computeIfAbsent(userId, this::createServiceForUser);
    }

    // 当用户更新存储配置时，调用此方法清除缓存，下次会生成新实例
    public void invalidateUserService(String userId) {
        userServiceCache.remove(userId);
    }

    // 为指定用户创建对应的服务实例
    private DocumentService createServiceForUser(String userId) {
        UserStorageConfig config = preferenceService.getStorageConfigByUserId(userId);
        switch (config.getStorageType()) {
            case S3:
                AmazonS3DocumentService s3Service = applicationContext.getBean(AmazonS3DocumentService.class);
                // 创建用户专属的S3客户端
                AmazonS3 s3Client = AmazonS3ClientBuilder.standard()
                        .withCredentials(new AWSStaticCredentialsProvider(
                                new BasicAWSCredentials(config.getS3AccessKey(), config.getS3SecretKey())))
                        .withRegion(config.getS3Region())
                        .build();
                s3Service.setS3Client(s3Client);
                return s3Service;
            case GOOGLE_STORAGE:
                GoogleStorageDocumentService googleService = applicationContext.getBean(GoogleStorageDocumentService.class);
                // 创建用户专属的Google Storage客户端
                try {
                    StorageOptions options = StorageOptions.newBuilder()
                            .setCredentials(ServiceAccountCredentials.fromStream(
                                    new FileInputStream(config.getGoogleJsonFilePath())))
                            .build();
                    googleService.setGoogleStorage(options.getService());
                } catch (IOException e) {
                    throw new RuntimeException("加载Google存储配置文件失败", e);
                }
                return googleService;
            default:
                throw new IllegalArgumentException("不支持的存储类型：" + config.getStorageType());
        }
    }

    private String getCurrentUserId() {
        return preferenceService.getCurrentUserStorageConfig().getUserId();
    }
}

4. 在业务代码中使用工厂 #

在需要操作文档的Service/Controller中，注入工厂并获取当前用户的服务实例：

@Service
public class DocumentBizService {
    private final DocumentServiceFactory serviceFactory;

    public DocumentBizService(DocumentServiceFactory serviceFactory) {
        this.serviceFactory = serviceFactory;
    }

    public void uploadUserDocument(MultipartFile file) {
        DocumentService documentService = serviceFactory.getCurrentUserDocumentService();
        documentService.upload(file);
    }

    public void deleteUserDocument(String docId) {
        DocumentService documentService = serviceFactory.getCurrentUserDocumentService();
        documentService.delete(docId);
    }
}

5. 处理配置更新的场景 #

当用户在偏好页面修改存储配置后，记得调用documentServiceFactory.invalidateUserService(userId)清除缓存，这样下次用户操作时就会基于新配置生成新的服务实例。

关键注意点 #

• 线程安全：用ConcurrentHashMap做缓存，确保多线程环境下的安全访问。
• 资源管理：如果客户端实例需要释放资源（比如连接池），可以在清除缓存前先关闭旧实例。
• 异常处理：在工厂类中捕获配置加载异常（比如JSON文件不存在、S3密钥无效），抛出友好的业务异常给上层处理。

内容的提问来源于stack exchange，提问作者ygk