Skip to content

[Autofix][warning] Alert #41: Poorly documented large function #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
xengine-qyt wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

[Autofix][warning] Alert #41: Poorly documented large function #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions XEngine_Source/MQCore_ConfigModule/Config_Json/Config_Json.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,28 @@ CConfig_Json::~CConfig_Json()
//////////////////////////////////////////////////////////////////////////
// 公用函数
//////////////////////////////////////////////////////////////////////////
// 函数名称: Config_Json_File
// 功能说明:
// 读取指定 JSON 配置文件，并将结果填充到 XENGINE_SERVERCONFIG 结构体中。
// 函数按“参数校验 -> 文件读取 -> JSON 解析 -> 字段映射”流程执行。
//
// 参数:
// lpszConfigFile [in] 配置文件路径
// pSt_ServerConfig [out] 配置输出结构体，不能为空
//
// 返回值:
// true : 读取并解析成功
// false : 失败（同时设置 Config_IsErrorOccur / Config_dwErrorCode）
//
// 错误处理:
// - 参数或文件打开失败: ERROR_MQ_MODULE_CONFIG_JSON_PARAMENT
// - JSON 解析失败 : ERROR_MQ_MODULE_CONFIG_JSON_PARSE
bool CConfig_Json::Config_Json_File(LPCXSTR lpszConfigFile,XENGINE_SERVERCONFIG *pSt_ServerConfig)
{
// 初始化错误状态，默认本次调用无错误
Config_IsErrorOccur = false;

// 1) 参数有效性校验
if ((NULL == lpszConfigFile) || (NULL == pSt_ServerConfig))
{
Config_IsErrorOccur = true;
Expand All @@ -36,6 +54,7 @@ bool CConfig_Json::Config_Json_File(LPCXSTR lpszConfigFile,XENGINE_SERVERCONFIG
Json::Value st_JsonRoot;
Json::CharReaderBuilder st_JsonBuilder;

// 2) 打开并读取配置文件内容
FILE* pSt_File = _xtfopen(lpszConfigFile, _X("rb"));
if (NULL == pSt_File)
{
Expand All @@ -47,13 +66,15 @@ bool CConfig_Json::Config_Json_File(LPCXSTR lpszConfigFile,XENGINE_SERVERCONFIG
size_t nSize = fread(tszMsgBuffer, 1, sizeof(tszMsgBuffer), pSt_File);
fclose(pSt_File);

// 3) 解析 JSON 文本
std::unique_ptr<Json::CharReader> const pSt_JsonReader(st_JsonBuilder.newCharReader());
if (!pSt_JsonReader->parse(tszMsgBuffer, tszMsgBuffer + nSize, &st_JsonRoot, &st_JsonError))
{
Config_IsErrorOccur = true;
Config_dwErrorCode = ERROR_MQ_MODULE_CONFIG_JSON_PARSE;
return false;
}
// 4) 将 JSON 字段映射到配置结构体
_tcsxcpy(pSt_ServerConfig->tszIPAddr,st_JsonRoot["tszIPAddr"].asCString());
_tcsxcpy(pSt_ServerConfig->tszTopic, st_JsonRoot["tszTopic"].asCString());
pSt_ServerConfig->bDeamon = st_JsonRoot["bDeamon"].asInt();
Expand Down