admin777/AvaloniaStack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

引入后端API项目并重构前后端桥接与路由

Browse Source 
本次提交新增了 Avalonia-API（Web API）与 Avalonia-Services（业务服务）两个项目，完善了解决方案结构。重构了 Avalonia-PC 前端与后端的桥接逻辑，实现了基于前缀的路由分发、静态服务、开发者工具等功能。同步更新了 .gitignore、api.js 及相关配置文件，为后续业务扩展和维护打下基础。
This commit is contained in:
admin777
2026-04-23 17:25:31 +08:00
parent 9b90a471c2
commit 506ab4857a
16 changed files with 455 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Avalonia-PC/Avalonia-PC.slnx
+2
View File
@@ -1,3 +1,5 @@
<Solution>
<Project Path="../Avalonia-API/Avalonia-API.csproj" Id="e33aba9a-a56b-4f6b-8eaa-3acbed65ebad" />
<Project Path="../Avalonia-Services/Avalonia-Services.csproj" Id="b8757cf9-5422-4c67-acae-3c967c95f866" />
<Project Path="Avalonia-PC.csproj" />
</Solution>
Avalonia-PC/Views/MainWindow.axaml.cs
+273 -24
View File
@@ -15,6 +15,7 @@ namespace Avalonia_PC.Views
public partial class MainWindow : Window
{
private const string AppScheme = "app";
//private const string? OnlineStartupUrl = "https://re.laitool.cn";
private const string? OnlineStartupUrl = null;
private const string? LocalStartupPath = null;
private static readonly JsonSerializerOptions BridgeJsonSerializerOptions = new()
@@ -30,6 +31,11 @@ namespace Avalonia_PC.Views
private string? _localHttpBaseUrl;
private string? _localHttpRoot;
#region 生命周期与 WebView 事件
/// <summary>
/// 初始化窗口并注册生命周期事件。
/// </summary>
public MainWindow()
{
InitializeComponent();
@@ -38,6 +44,9 @@ namespace Avalonia_PC.Views
Closed += OnClosed;
}
/// <summary>
/// 窗口打开后初始化 WebView、挂载事件并加载入口页面。
/// </summary>
private async void OnOpened(object? sender, EventArgs e)
{
if (_eventsAttached)
@@ -59,11 +68,17 @@ namespace Avalonia_PC.Views
await LoadInitialContentAsync();
}
/// <summary>
/// WebView 适配器创建后缓存实例，用于后续打开开发者工具。
/// </summary>
private void OnAdapterCreated(object? sender, WebViewAdapterEventArgs e)
{
_webViewAdapter = e.GetType().GetProperty("Adapter")?.GetValue(e);
}
/// <summary>
/// 窗口关闭时解绑事件并释放本地资源。
/// </summary>
private void OnClosed(object? sender, EventArgs e)
{
if (_webView is not null)
@@ -77,11 +92,21 @@ namespace Avalonia_PC.Views
StopLocalHttpServer();
}
/// <summary>
/// 页面导航完成后注入 JS 桥接脚本。
/// </summary>
private async void OnNavigationCompleted(object? sender, WebViewNavigationCompletedEventArgs e)
{
await InjectBridgeScriptAsync();
}
#endregion
#region 前端桥接与页面加载
/// <summary>
/// 接收前端消息并进行分发（打开调试工具 / 处理 app 请求）。
/// </summary>
private async void OnWebMessageReceived(object? sender, WebMessageReceivedEventArgs e)
{
var messageJson = e.Body;
@@ -137,6 +162,9 @@ namespace Avalonia_PC.Views
}
}
/// <summary>
/// 加载初始页面：优先在线地址，其次本地路径（通过本地 HTTP 服务托管）。
/// </summary>
private async Task LoadInitialContentAsync()
{
if (_webView is null)
@@ -174,6 +202,9 @@ namespace Avalonia_PC.Views
_webView.Source = new Uri(new Uri(_localHttpBaseUrl), Path.GetFileName(localHtmlPath));
}
/// <summary>
/// 向页面注入桥接脚本，接管 app:// 请求并回传到 C# 处理。
/// </summary>
private async Task InjectBridgeScriptAsync()
{
if (_webView is null)
@@ -278,6 +309,13 @@ if (!window.__appBridgeInstalled) {
await _webView.InvokeScript(script);
}
#endregion
#region 请求分发与通用响应
/// <summary>
/// 解析前端请求消息并转发到统一请求处理入口。
/// </summary>
private async Task<AppResponse> HandleAppRequestAsync(JsonElement request)
{
var id = request.TryGetProperty("id", out var idProperty) ? idProperty.GetString() : null;
@@ -289,6 +327,9 @@ if (!window.__appBridgeInstalled) {
return await HandleAppRequestAsync(id, url, method, body, headers);
}
/// <summary>
/// 统一请求处理：构建上下文、处理 OPTIONS、按前缀分发并封装标准响应。
/// </summary>
private async Task<AppResponse> HandleAppRequestAsync(
string? id,
string? rawUrl,
@@ -308,10 +349,7 @@ if (!window.__appBridgeInstalled) {
try
{
var uri = new Uri(rawUrl ?? throw new InvalidOperationException("请求地址不能为空。"));
var path = uri.AbsolutePath.TrimStart('/');
var normalizedPath = path.StartsWith("api/", StringComparison.OrdinalIgnoreCase)
? path
: $"api/{path}";
var requestContext = CreateRouteRequestContext(uri, body);
var authorization = GetAuthorizationHeader(headers);
_ = authorization;
@@ -323,27 +361,12 @@ if (!window.__appBridgeInstalled) {
return response;
}
if (string.Equals(normalizedPath, "api/getUser", StringComparison.OrdinalIgnoreCase))
var routeResult = await DispatchByPrefixAsync(requestContext);
if (routeResult.IsMatched)
{
var user = await GetUserFromDatabaseAsync();
response.Body = JsonSerializer.Serialize(new { success = true, data = user });
return response;
}
if (string.Equals(normalizedPath, "api/processData", StringComparison.OrdinalIgnoreCase))
{
var input = string.Empty;
if (!string.IsNullOrWhiteSpace(body))
{
using var jsonDocument = JsonDocument.Parse(body);
if (jsonDocument.RootElement.TryGetProperty("input", out var inputProperty))
{
input = inputProperty.GetString() ?? string.Empty;
}
}
var result = await ProcessDataAsync(input);
response.Body = JsonSerializer.Serialize(new { success = true, result });
response.StatusCode = routeResult.StatusCode;
response.StatusMessage = routeResult.StatusMessage;
response.Body = BuildSuccessResponseBody(routeResult.Data);
return response;
}
@@ -361,6 +384,137 @@ if (!window.__appBridgeInstalled) {
}
}
/// <summary>
/// 按请求前缀分发处理器（例如 api、sys、admin 等）。
/// </summary>
private async Task<RouteDispatchResult> DispatchByPrefixAsync(RouteRequestContext requestContext)
{
if (requestContext.PathSegments.Length > 0 &&
string.Equals(requestContext.PathSegments[0], "api", StringComparison.OrdinalIgnoreCase))
{
return await HandleApiPrefixAsync(requestContext);
}
return RouteDispatchResult.NotMatched();
}
/// <summary>
/// 处理 api 前缀下的具体业务路由。
/// </summary>
private static async Task<RouteDispatchResult> HandleApiPrefixAsync(RouteRequestContext requestContext)
{
if (string.Equals(requestContext.NormalizedPath, "api/getUser", StringComparison.OrdinalIgnoreCase))
{
var user = await GetUserFromDatabaseAsync();
return RouteDispatchResult.Success(user);
}
if (string.Equals(requestContext.NormalizedPath, "api/processData", StringComparison.OrdinalIgnoreCase) ||
(requestContext.PathSegments.Length > 1 &&
string.Equals(requestContext.PathSegments[1], "processData", StringComparison.OrdinalIgnoreCase)))
{
var input = ExtractInput(requestContext);
var result = await ProcessDataAsync(input);
return RouteDispatchResult.Success(result);
}
return RouteDispatchResult.NotMatched();
}
/// <summary>
/// 统一构建成功响应体，保持前后端响应结构一致。
/// </summary>
private static string BuildSuccessResponseBody(object? data)
{
return JsonSerializer.Serialize(new { success = true, data });
}
/// <summary>
/// 从 URI 解析路径段、查询参数和 body，构建路由上下文。
/// </summary>
private static RouteRequestContext CreateRouteRequestContext(Uri uri, string? body)
{
var host = uri.Host ?? string.Empty;
var absolutePath = uri.AbsolutePath ?? string.Empty;
var combinedPath = $"{host}/{absolutePath}";
var pathSegments = combinedPath
.Split('/', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries)
.Select(Uri.UnescapeDataString)
.ToArray();
var normalizedPath = string.Join('/', pathSegments);
var query = ParseQueryParameters(uri.Query);
return new RouteRequestContext
{
NormalizedPath = normalizedPath,
PathSegments = pathSegments,
Query = query,
Body = body,
};
}
/// <summary>
/// 解析查询字符串为忽略大小写的字典。
/// </summary>
private static Dictionary<string, string> ParseQueryParameters(string? queryString)
{
var query = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
if (string.IsNullOrWhiteSpace(queryString))
{
return query;
}
var raw = queryString.TrimStart('?');
foreach (var pair in raw.Split('&', StringSplitOptions.RemoveEmptyEntries))
{
var separatorIndex = pair.IndexOf('=');
if (separatorIndex < 0)
{
query[Uri.UnescapeDataString(pair)] = string.Empty;
continue;
}
var key = Uri.UnescapeDataString(pair[..separatorIndex]);
var value = Uri.UnescapeDataString(pair[(separatorIndex + 1)..]);
query[key] = value;
}
return query;
}
/// <summary>
/// 按 body -> query -> path 的优先级提取业务输入参数。
/// </summary>
private static string ExtractInput(RouteRequestContext requestContext)
{
if (!string.IsNullOrWhiteSpace(requestContext.Body))
{
using var jsonDocument = JsonDocument.Parse(requestContext.Body);
if (jsonDocument.RootElement.TryGetProperty("input", out var inputProperty))
{
return inputProperty.GetString() ?? string.Empty;
}
}
if (requestContext.Query.TryGetValue("input", out var inputFromQuery) &&
!string.IsNullOrWhiteSpace(inputFromQuery))
{
return inputFromQuery;
}
if (requestContext.PathSegments.Length > 2)
{
return string.Join('/', requestContext.PathSegments.Skip(2));
}
return string.Empty;
}
/// <summary>
/// 创建桥接响应的默认 JSON/CORS 头。
/// </summary>
private static Dictionary<string, string> CreateJsonHeaders() => new()
{
["Content-Type"] = "application/json; charset=utf-8",
@@ -369,6 +523,9 @@ if (!window.__appBridgeInstalled) {
["Access-Control-Allow-Headers"] = "Content-Type, Authorization",
};
/// <summary>
/// 从前端请求消息中提取请求头。
/// </summary>
private static Dictionary<string, string> ExtractHeaders(JsonElement request)
{
if (!request.TryGetProperty("headers", out var headersElement) ||
@@ -386,12 +543,18 @@ if (!window.__appBridgeInstalled) {
return headers;
}
/// <summary>
/// 获取授权头，供鉴权逻辑扩展使用。
/// </summary>
private static string? GetAuthorizationHeader(Dictionary<string, string> headers)
{
return headers.FirstOrDefault(
entry => string.Equals(entry.Key, "Authorization", StringComparison.OrdinalIgnoreCase)).Value;
}
/// <summary>
/// 在异常情况下尝试提取请求 id，确保前端可收到对应错误响应。
/// </summary>
private static string? TryGetRequestId(string messageJson)
{
try
@@ -405,6 +568,13 @@ if (!window.__appBridgeInstalled) {
}
}
#endregion
#region 页面地址配置与本地静态服务
/// <summary>
/// 获取在线启动地址配置（仅允许 http/https）。
/// </summary>
private static Uri? GetConfiguredOnlineStartupUrl()
{
if (string.IsNullOrWhiteSpace(OnlineStartupUrl))
@@ -420,6 +590,9 @@ if (!window.__appBridgeInstalled) {
return uri.Scheme is "http" or "https" ? uri : null;
}
/// <summary>
/// 获取本地启动文件路径，未配置时默认使用输出目录 www/index.html。
/// </summary>
private static string? GetConfiguredLocalStartupPath()
{
if (!string.IsNullOrWhiteSpace(LocalStartupPath))
@@ -430,6 +603,9 @@ if (!window.__appBridgeInstalled) {
return Path.Combine(AppContext.BaseDirectory, "www", "index.html");
}
/// <summary>
/// 确保本地 HTTP 静态服务已启动；根目录变化时会重启。
/// </summary>
private async Task EnsureLocalHttpServerStartedAsync(string localRoot)
{
if (!string.IsNullOrWhiteSpace(_localHttpBaseUrl) &&
@@ -454,6 +630,9 @@ if (!window.__appBridgeInstalled) {
_ = Task.Run(() => RunLocalHttpServerLoopAsync(_localHttpServer, _localHttpServerCts.Token, localRoot));
}
/// <summary>
/// 本地静态服务主循环，持续接收并分发请求。
/// </summary>
private static async Task RunLocalHttpServerLoopAsync(HttpListener listener, CancellationToken cancellationToken, string wwwRoot)
{
try
@@ -469,6 +648,9 @@ if (!window.__appBridgeInstalled) {
}
}
/// <summary>
/// 处理本地静态资源请求并返回文件内容。
/// </summary>
private static async Task HandleLocalHttpRequest(HttpListenerContext context, string wwwRoot)
{
try
@@ -509,6 +691,9 @@ if (!window.__appBridgeInstalled) {
}
}
/// <summary>
/// 根据后缀返回静态资源 Content-Type。
/// </summary>
private static string GetContentType(string filePath)
{
return Path.GetExtension(filePath).ToLowerInvariant() switch
@@ -521,6 +706,9 @@ if (!window.__appBridgeInstalled) {
};
}
/// <summary>
/// 获取一个可用本地端口，用于启动本地静态服务。
/// </summary>
private static int GetAvailableTcpPort()
{
var listener = new TcpListener(IPAddress.Loopback, 0);
@@ -530,6 +718,9 @@ if (!window.__appBridgeInstalled) {
return port;
}
/// <summary>
/// 尝试打开 WebView 开发者工具（兼容不同适配器方法名）。
/// </summary>
private void TryOpenDevTools()
{
if (_webViewAdapter is null)
@@ -543,6 +734,9 @@ if (!window.__appBridgeInstalled) {
method?.Invoke(_webViewAdapter, null);
}
/// <summary>
/// 停止并释放本地静态服务资源。
/// </summary>
private void StopLocalHttpServer()
{
try
@@ -564,18 +758,32 @@ if (!window.__appBridgeInstalled) {
}
}
#endregion
#region 业务示例方法
/// <summary>
/// 示例：模拟读取用户数据。
/// </summary>
private static async Task<object> GetUserFromDatabaseAsync()
{
await Task.Delay(100);
return new { id = 1, name = "张三", email = "zhangsan@example.com" };
}
/// <summary>
/// 示例：模拟处理输入数据。
/// </summary>
private static async Task<string> ProcessDataAsync(string? input)
{
await Task.Delay(200);
return $"Processed: {input?.ToUpperInvariant()}";
}
#endregion
#region DTO / 路由上下文模型
private sealed class AppResponse
{
public string Kind { get; set; } = string.Empty;
@@ -590,5 +798,46 @@ if (!window.__appBridgeInstalled) {
public Dictionary<string, string> Headers { get; set; } = new();
}
private sealed class RouteRequestContext
{
public string NormalizedPath { get; init; } = string.Empty;
public string[] PathSegments { get; init; } = [];
public Dictionary<string, string> Query { get; init; } = new(StringComparer.OrdinalIgnoreCase);
public string? Body { get; init; }
}
private sealed class RouteDispatchResult
{
public bool IsMatched { get; init; }
public int StatusCode { get; init; } = 200;
public string StatusMessage { get; init; } = "OK";
public object? Data { get; init; }
public static RouteDispatchResult Success(object? data)
{
return new RouteDispatchResult
{
IsMatched = true,
Data = data,
};
}
public static RouteDispatchResult NotMatched()
{
return new RouteDispatchResult
{
IsMatched = false,
};
}
}
#endregion
}
}
Avalonia-PC/www/api.js
+1 -1
View File
@@ -45,6 +45,6 @@ async function callApi(endpoint, options = {}) {
}
window.api = {
getUser: () => callApi("getUser"),
getUser: () => callApi("getUser?t=1"),
processData: (input) => callApi("processData", { method: "POST", body: { input } })
};