tangxbai / dictionary-map-spring-boot Goto Github PK

@EnableDictionaryMap
@SpringBootApplication
public class Application {
    
    public static void main( String [] args ) throws Exception {
        SpringApplication.run( Application.class, args );
    }
    
}

// 1、在 spring bean 中，通过注入的方式获取引用
@Autowired
private DictManager dictManager;
dictManager.xxx();

// 2、在普通类中直接使用静态上下文
DictManager dictManager = DictContext.manager();
dictManager.xxx();

// 国际化相关
List<Language> getLanguages(); // 查询所有语种
boolean addLanguage( Language language ); // 添加一个语种
int updateLanguage( Language language ); // 更新已有语种
int removeLanguage( Language language ); // 删除一个语种
boolean existLanguage( Language language ); // 检测是否存在某语种
boolean addSnapshot( Locale source, Locale destination ); // 从指定语言快速拷贝

// 字典相关
Map<String, Object> expandAll(); // 展开语义化的JSON数据格式
List<Dictionary> getAll(); // 查询所有字典列表【仅包含启用的】
List<Dictionary> getAllAlways(); // 查询所有字典列表【忽略状态】
List<Dictionary> get( String key ); // 查询指定键的字典列表【仅包含启用的】
List<Dictionary> getAlways( String key ); // 查询指定键的字典列表【忽略状态】
List<Dictionary> get( String ... key ); // 查询指定键的字典列表【仅包含启用的】
List<Dictionary> getAlways( String ... key ); // 查询指定键的字典列表【忽略状态】
Dictionary match( String key, Integer code ); // 精确匹配指定key和code的字典项【仅包含启用的】
Dictionary matchAlways( String key, Integer code ); // 精确匹配指定key和code的字典项【忽略状态】
Dictionary match( String key, String alias ); // 精确匹配指定key和alias的字典项【仅包含启用的】
Dictionary matchAlways( String key, String alias ); // 精确匹配指定key和alias的字典项【忽略状态】
Dictionary matching( String key, Predicate<Dictionary> predicate ); // 自定义精确匹配筛选
boolean add( Locale locale, Dictionary dict ); // 为某个语种添加一个字典项
boolean addBatch( Locale locale, List<Dictionary dictionaries ); // 为某个语种添加一批字典项
int update( Locale locale, Dictionary dict ); // 更新某个语种下的字典项
int updateBatch( Locale locale, List<Dictionary dictionaries ); // 批量更新某个语种下的字典项
boolean change( Locale locale, String key, Integer code, boolean status ); // 更改字典项状态【locale为空则更新所有】
boolean remove( Locale locale, String key, Integer code ); // 删除字典项【locale为空则更新所有】

@Configuration
public class DictionaryConfiguration {
    
    private final DictionaryProperties props;
    
    public DictionaryConfiguration( DictionaryProperties props ) {
        this.props = props;
    }
    
    /**
     * (DEFAULT) 主键生成器
     * 
     * @return the id generator
     * @see com.viiyue.plugins.dict.spring.boot.config.DictionaryAuoConfiguration
     */
    @Bean
    public IdResolver idResolver() {
        return IdGenerator::nextId;
    }
    
    /**
     * (DEFAULT) 如果出现某SQL与数据库平台不符，可以通过此方式进行方法重载。
     * 
     * @return the sql resolver
     * @see com.viiyue.plugins.dict.spring.boot.config.DictionaryAuoConfiguration
     */
    @Bean
    @ConditionalOnMissingBean
    public SqlResolver sqlResolver() {
        return new DefaultSqlResolver( props );
    }
    
    /**
     * (DEFAULT) 定义字典国际化语言获取方式
     * 
     * @return the language resolver instance
     * @see com.viiyue.plugins.dict.spring.boot.config.DictionaryAuoConfiguration
     */
    @Bean
    @ConditionalOnMissingBean
    public LanguageResolver languageResolver() {
        return props.hasDefaultLocale() ? props::getLocale : (() -> {
            // 1. 尝试获取本地 HttpServletRequest（一般都能获取到）
            RequestAttributes attributes = RequestContextHolder.getRequestAttributes();
            if ( attributes == null ) {
                return null;
            }
            HttpServletRequest request = ( ( ServletRequestAttributes ) attributes ).getRequest();
            if ( request == null ) {
                return null;
            }

            // 2. 首先尝试从请求参数中获取
            String queryName = props.getLocaleQuery();
            String language = request.getParameter( queryName ); // zh-CN
            if ( !StringUtils.isEmpty( language ) ) {
                language = language.replace( '_', '-' ); // Or zh_CN
                return Locale.forLanguageTag( language );
            }

            // 3. 如果请求中未获取到则尝试通过Spring的国际化解析器获取，还是未果则最后获取请求头中的语言设置。
            return RequestContextUtils.getLocale( request );
        });
    }
    
}

com.viiyue.plugins.dict.spring.boot.config.mybatis.DictionaryInterceptor
com.viiyue.plugins.dict.spring.boot.config.mybatis.DictionaryTypeHandler

@Table( name = "t_your_table" )
public class YourModelBean {

    @Id
    private Long id;
    
    @Dict( "user.gender" )
    private Dictionary gender; // 数据库的 code 值会自动转换为字典对象
    
    @Dict( "dict.key.xxx" )
    private Dictionary xxxxxx; // 数据库的 code 值会自动转换为字典对象
    
}

com.viiyue.plugins.dict.spring.boot.config.resolver.DictionaryArgumentResolver

URL: /query/xxx?gender=1

@GetMapping( "/query/xxx" )
public void doQuery( @Dict( "user.gender" ) Dictionary gender ) {
    System.out.println( gender );
}

com.viiyue.plugins.dict.spring.boot.config.resolver.DictionaryConverter
com.viiyue.plugins.dict.spring.boot.config.resolver.DictionaryJsonSerializer

public class User {
    private int id;
    private String username;
    @Dict( "user.gender" ) 
    private Dictionary gender;
}

/** 
 * 1、From 表单
 * 通过向 Spring 注册 Converter 提供转换支持
 *
 * @param user 表单参数
 * @see com.viiyue.plugins.dict.spring.boot.config.resolver.DictionaryConverter
 */
@GetMapping( "/query/xxx" )
public void doQuery( User user ) {
    System.out.println( user );
}

/** 
 * 2、JSON 参数
 * 通过向 Jackson 中注册 JsonSerrializer 提供转换支持
 *
 * @param user JSON格式的参数
 * @see com.viiyue.plugins.dict.spring.boot.config.resolver.DictionaryJsonSerializer
 */
@GetMapping( "/query/xxx" )
public void doQuery( @RrquestBody User user ) {
	System.out.println( user );
}

public class User {
    private int id;
    private String username;
    private Dictionary gender;
}

@RestController
@RequestMapping( "/demo" )
public class YourController {
    
    @Autowired
    private YourService service;
    
    @GetMapping( "/users" )
    public List<User> doQuery() {
        return service.selectAll();
    } 
    
}