类 I18nController
java.lang.Object
net.sohelp.boot.admin.core.base.BaseController
net.sohelp.boot.dev.web.system.i18n.I18nController
@RestController("dev-system-i18n")
@RequestMapping("/dev/system/i18n")
public class I18nController
extends BaseController
国际化标准管理控制器
提供国际化数据的增删改查、构建及导出功能,支持按模块或实体生成国际化配置。
- 从以下版本开始:
- 2022/8/29
- 作者:
- AaronFung
-
字段概要
从类继承的字段 net.sohelp.boot.admin.core.base.BaseController
request, response -
构造器概要
构造器 -
方法概要
修饰符和类型方法说明buildI18nByEntity(Map<String, Object> dataMap) 根据实体生成I18N数据 该接口接收包含实体信息的Map对象,根据实体信息生成对应的I18N数据并返回buildI18nByTable(Map<String, Object> dataMap) 生成I18N数据 根据传入的表名、数据源以及是否生成JSON格式数据,生成对应的I18N数据删除指定ID的国际化记录 根据传入的ID删除对应的国际化条目。downloadI18nByAllEntity(String datasourceName, boolean json) 生成并下载I18N文件 该接口用于生成I18N文件,并将其作为附件下载。downloadI18nByAllTable(String datasourceName, boolean json) 生成并下载I18N文件 该接口用于生成I18N文件,并将其作为附件下载。根据ID获取单个国际化记录 查询指定ID且属于当前租户的国际化记录。获取国际化详情(空实现) 当前方法未完成具体逻辑,仅返回一个空Map。查询所有国际化数据列表 获取满足条件的所有国际化记录,不分页。分页查询国际化数据 该接口用于分页查询国际化相关的数据,通过传入的参数进行条件筛选,并返回查询结果。pageByType(Map<String, Object> paramMap) 根据类型分页查询国际化数据 支持三种类型:0表示模块,1表示数据库表字段,2表示实体属性。修改国际化记录及其语言版本 更新国际化主记录的基本信息,并更新或插入各语言版本的内容。从类继承的方法 net.sohelp.boot.admin.core.base.BaseController
error, error, fail, fail, fail, getLoginID, getLoginName, getLoginOrgID, getLoginOrgName, getLoginUser, getNickname, getTenantId, getUserName, getUserNo, i18n, i18n, isAdministrator, isDeveloper, limit, offset, ok, ok, response, response, responseStream, success, success, success, success, validateToken
-
构造器详细资料
-
I18nController
public I18nController()
-
-
方法详细资料
-
page
@Permission("ADMIN") @GetMapping("/page") public ApiResult<Pager<Map<String,Object>>> page(@RequestParam Map<String, Object> paramMap) throws Exception分页查询国际化数据 该接口用于分页查询国际化相关的数据,通过传入的参数进行条件筛选,并返回查询结果。- 参数:
paramMap- 包含查询条件的参数映射,其中可包含分页参数以及筛选条件,例如租户ID等- 返回:
- ApiResult无效输入:'<'Pager 无效输入:'<' Map 无效输入:'<' String, Object>>> 包含分页查询结果的API结果对象
- 抛出:
Exception- 如果查询过程中发生异常,则抛出Exception异常
-
list
@GetMapping("/list") @Permission("ADMIN") public ApiResult<List<Map<String,Object>>> list(@RequestParam Map<String, Object> paramMap) throws Exception查询所有国际化数据列表 获取满足条件的所有国际化记录,不分页。- 参数:
paramMap- 查询参数集合,包括租户ID等过滤条件- 返回:
- 所有匹配的国际化记录列表
- 抛出:
Exception- 查询失败时抛出异常
-
delete
@PostMapping("/delete") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("DEVELOPER") @OperationLog("\u5220\u9664\u56fd\u9645\u5316") public ApiResult<String> delete(@RequestBody Map<String, Object> paramMap) throws Exception删除指定ID的国际化记录 根据传入的ID删除对应的国际化条目。- 参数:
paramMap- 请求体中的参数,必须包含"id"字段- 返回:
- 操作结果提示信息
- 抛出:
Exception- 删除操作失败时抛出异常
-
getDetail
@GetMapping("/getDetail") @Permission("ADMIN") public ApiResult<Map<String,Object>> getDetail(@RequestParam Object id) throws Exception 获取国际化详情(空实现) 当前方法未完成具体逻辑,仅返回一个空Map。- 参数:
id- 记录唯一标识符- 返回:
- 空的国际化详情Map
- 抛出:
Exception- 方法执行中可能发生的异常
-
getById
@GetMapping("/getById") @Permission("ADMIN") public ApiResult<Map<String,Object>> getById(@RequestParam String id) throws Exception 根据ID获取单个国际化记录 查询指定ID且属于当前租户的国际化记录。- 参数:
id- 要查询的国际化记录ID- 返回:
- 对应的国际化记录Map
- 抛出:
Exception- 查询失败时抛出异常
-
pageByType
@GetMapping("/pageByType") @Permission("ADMIN") public ApiResult<Pager<Map<String,Object>>> pageByType(@RequestParam Map<String, Object> paramMap) throws Exception根据类型分页查询国际化数据 支持三种类型:0表示模块,1表示数据库表字段,2表示实体属性。- 参数:
paramMap- 参数Map,需包含"type"和可选的"datasourceName"- 返回:
- 分页后的国际化数据
- 抛出:
Exception- 处理过程中的异常
-
buildI18nByTable
@PostMapping("/buildI18nByTable") @Permission("ADMIN") public ApiResult<String> buildI18nByTable(@RequestBody Map<String, Object> dataMap) throws Exception生成I18N数据 根据传入的表名、数据源以及是否生成JSON格式数据,生成对应的I18N数据- 参数:
dataMap- 包含生成I18N所需数据的Map - table: 需要生成I18N数据的表名列表 - json: 是否生成JSON格式数据 - datasource: 数据源名称- 返回:
- 返回生成的I18N数据的JSON字符串
- 抛出:
Exception- 如果生成I18N数据过程中出现异常,则抛出Exception
-
buildI18nByEntity
@PostMapping("/buildI18nByEntity") @Permission("ADMIN") public ApiResult<String> buildI18nByEntity(@RequestBody Map<String, Object> dataMap) throws Exception根据实体生成I18N数据 该接口接收包含实体信息的Map对象,根据实体信息生成对应的I18N数据并返回- 参数:
dataMap- 包含实体信息、是否返回json格式数据以及数据源的Map对象- 返回:
- 生成I18N数据的ApiResult对象
- 抛出:
Exception- 如果处理过程中发生异常,抛出Exception异常
-
downloadI18nByAllEntity
@GetMapping("/downloadI18nByAllEntity") @Permission("ADMIN") public ApiResult<String> downloadI18nByAllEntity(@RequestParam(required=false) String datasourceName, @RequestParam(required=false) boolean json) throws Exception 生成并下载I18N文件 该接口用于生成I18N文件,并将其作为附件下载。支持指定数据源名称和是否生成JSON格式的I18N内容。- 参数:
datasourceName- 数据源名称(可选,默认为空)json- 是否生成JSON格式的I18N内容(可选,默认为false)- 返回:
- 返回ApiResult
对象,但由于文件直接写入响应输出流,实际返回null - 抛出:
Exception- 如果在生成或下载I18N文件过程中发生异常,将抛出Exception
-
downloadI18nByAllTable
@GetMapping("/downloadI18nByAllTable") @Permission("ADMIN") public ApiResult<String> downloadI18nByAllTable(@RequestParam(required=false) String datasourceName, @RequestParam(required=false) boolean json) throws Exception 生成并下载I18N文件 该接口用于生成I18N文件,并将其作为附件下载。支持指定数据源名称和是否生成JSON格式的I18N内容。- 参数:
datasourceName- 数据源名称,可选参数。如果不指定,将使用默认数据源。json- 是否生成JSON格式的I18N内容,可选参数。如果为true,则生成JSON格式;否则生成properties格式。- 返回:
- 返回ApiResult
类型,但由于文件直接写入响应流,因此实际返回null。 - 抛出:
Exception- 如果在生成或下载I18N文件过程中发生异常,将抛出该异常。
-
update
@PostMapping("/update") @Transactional(rollbackFor=java.lang.Exception.class) @Permission("DEVELOPER") public ApiResult<String> update(@RequestBody Map<String, Object> paramMap) throws Exception修改国际化记录及其语言版本 更新国际化主记录的基本信息,并更新或插入各语言版本的内容。- 参数:
paramMap- 请求体参数,包含以下结构: { "name":"", "module_uuid":"", "type":1, "is_java":1, "is_custom":1, "i18nArr":[{ "i18n":"", "lang_no":"" }] }- 返回:
- 成功消息
- 抛出:
Exception- 修改失败时抛出异常
-