org.shoulder.web.template.crud.CrudCacheableController Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of shoulder-web Show documentation

shoulder WEB 模块，基于Spring Boot Web提供了 Controller AOP 日志、AOP异常处理，统一返回值，健康检查，租户、用户解析，Web 安全防护，通用CrudController，动态字典，标签管理，HTTP client AOP日志、AOP异常处理等能力，助力Web飞速开发。

The newest version!

package org.shoulder.web.template.crud;

import io.swagger.v3.oas.annotations.Operation;
import org.shoulder.core.converter.ShoulderConversionService;
import org.shoulder.core.dto.response.BaseResult;
import org.shoulder.data.mybatis.template.entity.BaseEntity;
import org.shoulder.data.mybatis.template.service.BaseCacheableService;
import org.shoulder.log.operation.annotation.OperationLog;
import org.springframework.web.bind.annotation.PostMapping;

import java.io.Serializable;

/**
 * 带缓存的
 * 查询时优先查缓存，并提供了刷新缓存的接口
 *
 * @author lym
 */
public abstract class CrudCacheableController<
        SERVICE extends BaseCacheableService,
        ENTITY extends BaseEntity,
        ID extends Serializable,
        QueryResultDTO extends Serializable,
        PageQuery extends Serializable,
        SaveDTO extends Serializable,
        UpdateDTO extends Serializable>
    extends CrudController {

    /**
     * 查询
     *
     *  todo 处理缓存失效策略
     * @param id 主键id
     * @return 查询结果
     */
//    @Override
//    @OperationLog(operation = OperationLog.Operations.QUERY)
//    public BaseResult get(@PathVariable ID id) {
//        return BaseResult.success(convertEntityToQueryResult(service.getByIdFromCache(id)));
//    }
    public CrudCacheableController(SERVICE service, ShoulderConversionService conversionService) {
        super(service, conversionService);
    }


    /**
     * 刷新缓存
     *
     * @return 是否成功
     */
    @Operation(summary = "刷新缓存", description = "刷新缓存")
    @PostMapping("refreshCache")
    @OperationLog(operation = OperationLog.Operations.UPDATE)
    public BaseResult refreshCache() {
        service.refreshCache();
        return BaseResult.success(true);
    }

    /**
     * 清理缓存
     *
     * @return 是否成功
     */
    @Operation(summary = "清理缓存", description = "清理缓存")
    @PostMapping("clearCache")
    @OperationLog(operation = OperationLog.Operations.DELETE)
    public BaseResult clearCache() {
        service.clearCache();
        return BaseResult.success(true);
    }
}