Skip to content

Commit 89a258b

Browse files
committed
[修改]1. 修改返回接口类型
1 parent 1254287 commit 89a258b

File tree

9 files changed

+145
-116
lines changed

9 files changed

+145
-116
lines changed

GameFrameX.Client.Api/Controllers/GameAppVersionController.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public GameAppVersionController(BaseService<ClientAppVersion> service) : base(se
2525
/// <returns></returns>
2626
[ProducesResponseType(typeof(GameAppVersionResponse), 200)]
2727
[HttpPost]
28-
public async Task<ResultModel> GetInfo([FromBody] GameAppVersionRequest gameAppVersionRequest)
28+
public async Task<HttpResult> GetInfo([FromBody] GameAppVersionRequest gameAppVersionRequest)
2929
{
3030
var response = new GameAppVersionResponse();
3131
ClientAppVersion gameAppVersion = await PBaseService.GetAsync(m =>
@@ -81,15 +81,15 @@ public async Task<ResultModel> GetInfo([FromBody] GameAppVersionRequest gameAppV
8181

8282
if (gameAppVersion == null)
8383
{
84-
return ResultModel.Create(ResultCode.NotFound, "not found");
84+
return HttpResult.Create(HttpStatusCode.NotFound, "not found");
8585
}
8686

8787
response.IsForce = gameAppVersion.IsForce;
8888
response.IsUpgrade = gameAppVersionRequest.AppVersion != gameAppVersion.Version;
8989
response.UpdateAnnouncement = gameAppVersion.Announcement;
9090
response.AppDownloadUrl = gameAppVersion.DownloadUrl;
9191

92-
return ResultModel.Create(JsonConvert.SerializeObject(response));
92+
return HttpResult.Create(JsonConvert.SerializeObject(response));
9393
}
9494
}
9595
}

GameFrameX.Client.Api/Controllers/GameAssetPackageVersionController.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public GameAssetPackageVersionController(BaseService<ClientAssetPackageVersion>
2525
/// <returns></returns>
2626
[ProducesResponseType(typeof(AssetPackageVersionResponse), 200)]
2727
[HttpPost]
28-
public async Task<ResultModel> GetInfo([FromBody] AssetPackageVersionRequest request)
28+
public async Task<HttpResult> GetInfo([FromBody] AssetPackageVersionRequest request)
2929
{
3030
var response = new AssetPackageVersionResponse();
3131

@@ -99,7 +99,7 @@ public async Task<ResultModel> GetInfo([FromBody] AssetPackageVersionRequest req
9999

100100
if (gameResourceVersion == null)
101101
{
102-
return ResultModel.Create(ResultCode.NotFound, "not found");
102+
return HttpResult.Create(HttpStatusCode.NotFound, "not found");
103103
}
104104

105105
response.Language = gameResourceVersion.Language;
@@ -111,7 +111,7 @@ public async Task<ResultModel> GetInfo([FromBody] AssetPackageVersionRequest req
111111
response.PackageName = gameResourceVersion.Package;
112112
response.AppVersion = gameResourceVersion.AppVersion;
113113

114-
return ResultModel.Create(JsonConvert.SerializeObject(response));
114+
return HttpResult.Create(JsonConvert.SerializeObject(response));
115115
}
116116
}
117117
}

GameFrameX.Client.Api/Controllers/GameGlobalInfoController.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public GameGlobalInfoController(BaseService<ClientGlobalInfo> service) : base(se
2525
/// <returns></returns>
2626
[ProducesResponseType(typeof(GlobalInfoResponse), 200)]
2727
[HttpPost]
28-
public async Task<ResultModel> GetInfo([FromBody] GlobalInfoRequest globalInfoRequest)
28+
public async Task<HttpResult> GetInfo([FromBody] GlobalInfoRequest globalInfoRequest)
2929
{
3030
var response = new GlobalInfoResponse();
3131
ClientGlobalInfo gameGlobalInfo = await PBaseService.GetAsync(m =>
@@ -93,14 +93,14 @@ public async Task<ResultModel> GetInfo([FromBody] GlobalInfoRequest globalInfoRe
9393

9494
if (gameGlobalInfo == null)
9595
{
96-
return ResultModel.Create(ResultCode.NotFound, "not found");
96+
return HttpResult.Create(HttpStatusCode.NotFound, "not found");
9797
}
9898

9999
response.Content = gameGlobalInfo.Content;
100100
response.CheckAppVersionUrl = gameGlobalInfo.CheckAppVersionUrl;
101101
response.CheckResourceVersionUrl = gameGlobalInfo.CheckResourceUrl;
102102
response.AotCodeList = gameGlobalInfo.AotCodeList;
103-
return ResultModel.Create(JsonConvert.SerializeObject(response));
103+
return HttpResult.Create(JsonConvert.SerializeObject(response));
104104
}
105105
}
106106
}
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
namespace GameFrameX.Client.Api.Result;
2+
3+
/// <summary>
4+
/// 消息返回统一结构
5+
/// </summary>
6+
public class HttpResult
7+
{
8+
/// <summary>
9+
/// 消息码
10+
/// </summary>
11+
public HttpStatusCode code { get; set; }
12+
13+
/// <summary>
14+
/// 消息内容
15+
/// </summary>
16+
public string message { get; set; }
17+
18+
/// <summary>
19+
/// 实际数据
20+
/// </summary>
21+
public object data { get; set; }
22+
23+
/// <summary>
24+
/// 创建一个带有指定代码、消息和数据的 ResultModel 实例
25+
/// </summary>
26+
/// <param name="code">结果代码</param>
27+
/// <param name="message">结果消息</param>
28+
/// <param name="data">结果数据</param>
29+
/// <returns>带有指定代码、消息和数据的 ResultModel 实例</returns>
30+
public static HttpResult Create(HttpStatusCode code, string message, object data)
31+
{
32+
return new HttpResult() { code = code, message = message, data = data };
33+
}
34+
35+
/// <summary>
36+
/// 创建一个默认的 ResultModel 实例
37+
/// </summary>
38+
/// <returns>默认的 ResultModel 实例</returns>
39+
public static HttpResult Create()
40+
{
41+
return new HttpResult() { code = HttpStatusCode.Ok, message = HttpStatusCode.Ok.GetString() };
42+
}
43+
44+
/// <summary>
45+
/// 创建一个带有指定代码和消息的 ResultModel 实例
46+
/// </summary>
47+
/// <param name="code">结果代码</param>
48+
/// <param name="message">结果消息</param>
49+
/// <returns>带有指定代码和消息的 ResultModel 实例</returns>
50+
public static HttpResult Create(HttpStatusCode code, string message)
51+
{
52+
return new HttpResult() { code = code, message = message };
53+
}
54+
55+
/// <summary>
56+
/// 创建一个带有指定数据的 ResultModel 实例
57+
/// </summary>
58+
/// <param name="data">结果数据</param>
59+
/// <returns>带有指定数据的 ResultModel 实例</returns>
60+
public static HttpResult Create(object data)
61+
{
62+
return new HttpResult() { code = HttpStatusCode.Ok, message = HttpStatusCode.Ok.GetString(), data = data };
63+
}
64+
}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
namespace GameFrameX.Client.Api.Result;
2+
3+
/// <summary>
4+
/// 消息码常量定义
5+
/// </summary>
6+
public enum HttpStatusCode
7+
{
8+
/// <summary>
9+
/// 成功
10+
/// </summary>
11+
Ok = 0,
12+
13+
/// <summary>
14+
/// 没有找到
15+
/// </summary>
16+
NotFound = 200001,
17+
18+
/// <summary>
19+
/// 账号或密码错误
20+
/// </summary>
21+
AccountOrPasswordError = 602004,
22+
}
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
namespace GameFrameX.Client.Api.Result;
2+
3+
/// <summary>
4+
/// HTTP状态消息
5+
/// </summary>
6+
public static class HttpStatusMessage
7+
{
8+
/// <summary>
9+
/// 成功
10+
/// </summary>
11+
public const string Success = "ok";
12+
13+
/// <summary>
14+
/// 未定义的命令
15+
/// </summary>
16+
public const string UndefinedCommand = "undefined command";
17+
18+
/// <summary>
19+
/// 未找到的命令
20+
/// </summary>
21+
public const string NotFoundCommand = "not found command";
22+
23+
/// <summary>
24+
/// 验证失败的命令
25+
/// </summary>
26+
public const string CheckFailedCommand = "check failed command";
27+
28+
/// <summary>
29+
/// 服务器错误
30+
/// </summary>
31+
public const string ServerError = "server error";
32+
}

GameFrameX.Client.Api/Result/ResultCode.cs

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
1-
namespace GameFrameX.Client.Api.Result
1+
namespace GameFrameX.Client.Api.Result;
2+
3+
/// <summary>
4+
/// 返回码扩展
5+
/// </summary>
6+
public static class ResultCodeExtension
27
{
8+
private static readonly Dictionary<HttpStatusCode, string> CodeDictionary = new Dictionary<HttpStatusCode, string>()
9+
{
10+
{ HttpStatusCode.Ok, "ok" },
11+
{ HttpStatusCode.AccountOrPasswordError, "账号或密码错误" },
12+
};
13+
314
/// <summary>
4-
/// 返回码扩展
15+
/// 获取返回码的消息内容
516
/// </summary>
6-
public static class ResultCodeExtension
17+
/// <param name="code"></param>
18+
/// <returns></returns>
19+
public static string GetString(this HttpStatusCode code)
720
{
8-
private static readonly Dictionary<ResultCode, string> CodeDictionary = new Dictionary<ResultCode, string>()
9-
{
10-
{ ResultCode.Ok, "ok" },
11-
{ ResultCode.AccountOrPasswordError, "账号或密码错误" },
12-
};
13-
14-
/// <summary>
15-
/// 获取返回码的消息内容
16-
/// </summary>
17-
/// <param name="code"></param>
18-
/// <returns></returns>
19-
public static string GetString(this ResultCode code)
20-
{
21-
CodeDictionary.TryGetValue(code, out var desc);
22-
return desc ?? string.Empty;
23-
}
21+
CodeDictionary.TryGetValue(code, out var desc);
22+
return desc ?? string.Empty;
2423
}
2524
}

GameFrameX.Client.Api/Result/ResultModel.cs

Lines changed: 0 additions & 65 deletions
This file was deleted.

0 commit comments

Comments
 (0)