feat: Add a basic API framework.

2026-02-03 09:48:25 +00:00 · 2025-07-25 23:01:53 +08:00
15 changed files with 186 additions and 90 deletions
--- a/.github/workflows/dotnet.yml
+++ b/.github/workflows/dotnet.yml
@@ -9,101 +9,55 @@ on:
    branches: [ dev ]

 jobs:
-  # Windows 和 Linux 构建（保持在 Ubuntu 上）
-  build-linux-windows:
+  build:
    runs-on: ubuntu-latest
    steps:
      - name: Get build version
        id: date
-        run: echo "date=$(date +'%Y%m%d')${{github.run_number}}" >> $GITHUB_OUTPUT
+        run: echo "::set-output name=date::$(date +'%Y%m%d')${{github.run_number}}"
      - name: Checkout Code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v3
      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
+        uses: actions/setup-dotnet@v3
        with:
-          dotnet-version: 10.0.x
-      - name: Publish Windows and Linux
+          dotnet-version: 8.0.x
+      - name: Restore dependencies
+        run: dotnet restore
+      - name: Publish
        working-directory: ./src/ZonyLrcTools.Cli
        run: |
-          for platform in win-x64 linux-x64 win-arm64 linux-arm64; do
-            dotnet publish -r "$platform" -c Release -p:PublishSingleFile=true -p:UseAppHost=true -p:DebugType=none --self-contained true
-            cd ./bin/Release/net10.0/"$platform"/publish/
-            zip -r ./ZonyLrcTools_"$platform"_"${{ steps.date.outputs.date }}".zip ./
-            cd ../../../../../
-            mkdir -p ./TempFiles
-            mv ./bin/Release/net10.0/"$platform"/publish/*.zip ./TempFiles/
-          done
+          ls -a
+          chmod +x ./publish.sh
+          ./publish.sh
+          mv ./TempFiles ../../
        shell: bash
+        env:
+          PUBLISH_VERSION: ${{ steps.date.outputs.date }}
      - name: Upload artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v3
        with:
          retention-days: 90
-          name: release-files-linux-windows
-          path: ./src/ZonyLrcTools.Cli/TempFiles
+          name: release-files
+          path: |
+            ./TempFiles
+            ./versions/release.md
    outputs:
      version: ${{ steps.date.outputs.date }}
-
-  # macOS 构建（在 macOS runner 上，支持 ad-hoc 签名）
-  build-macos:
-    runs-on: macos-latest
-    steps:
-      - name: Get build version
-        id: date
-        run: echo "date=$(date +'%Y%m%d')${{github.run_number}}" >> $GITHUB_OUTPUT
-      - name: Checkout Code
-        uses: actions/checkout@v4
-      - name: Setup .NET
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: 10.0.x
-      - name: Publish macOS
-        working-directory: ./src/ZonyLrcTools.Cli
-        run: |
-          for platform in osx-x64 osx-arm64; do
-            dotnet publish -r "$platform" -c Release -p:PublishSingleFile=true -p:DebugType=none --self-contained true
-
-            # Ad-hoc 签名，解决 macOS Gatekeeper/XProtect 问题
-            codesign -s - --force --deep ./bin/Release/net10.0/"$platform"/publish/ZonyLrcTools.Cli
-
-            cd ./bin/Release/net10.0/"$platform"/publish/
-            zip -r ./ZonyLrcTools_"$platform"_"${{ steps.date.outputs.date }}".zip ./
-            cd ../../../../../
-            mkdir -p ./TempFiles
-            mv ./bin/Release/net10.0/"$platform"/publish/*.zip ./TempFiles/
-          done
-        shell: bash
-      - name: Upload artifact
-        uses: actions/upload-artifact@v4
-        with:
-          retention-days: 90
-          name: release-files-macos
-          path: ./src/ZonyLrcTools.Cli/TempFiles
-    outputs:
-      version: ${{ steps.date.outputs.date }}
-
-  # Release Job - 合并所有平台的构建产物
  release:
    if: github.event_name == 'push'
-    needs: [build-linux-windows, build-macos]
+    needs: build
    runs-on: ubuntu-latest
    steps:
-      - name: Checkout for release notes
-        uses: actions/checkout@v4
-      - name: Download Linux/Windows artifacts
-        uses: actions/download-artifact@v4
+      - name: Download artifact
+        uses: actions/download-artifact@v3
        with:
-          name: release-files-linux-windows
-          path: ./TempFiles
-      - name: Download macOS artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: release-files-macos
-          path: ./TempFiles
+          name: release-files
+          path: .
      - name: Upload Release
        uses: ncipollo/release-action@v1
        with:
          artifacts: "./TempFiles/*.zip"
          token: ${{ secrets.GITHUBACTIONS }}
-          tag: ZonyLrcToolsX_Alpha.${{ needs.build-linux-windows.outputs.version }}
+          tag: ZonyLrcToolsX_Alpha.${{ needs.build.outputs.version }}
          commit: dev
          bodyFile: ./versions/release.md
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -3,7 +3,7 @@
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <Nullable>enable</Nullable>
-    <Version>4.0.3</Version>
+    <Version>4.0.2</Version>
    <Authors>Zony(real-zony)</Authors>
    <RepositoryUrl>https://github.com/real-zony/ZonyLrcToolsX</RepositoryUrl>
  </PropertyGroup>
--- a/Directory.Packages.props
+++ b/Directory.Packages.props
@@ -3,23 +3,28 @@
    <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
  </PropertyGroup>
  <ItemGroup>
+    <PackageVersion Include="FastEndpoints" Version="7.0.1" />
+    <PackageVersion Include="FastEndpoints.Swagger" Version="7.0.1" />
+    <PackageVersion Include="FreeSql" Version="3.5.211" />
+    <PackageVersion Include="FreeSql.Provider.SqliteCore" Version="3.5.211" />
    <PackageVersion Include="McMaster.Extensions.CommandLineUtils" Version="4.1.1" />
    <PackageVersion Include="McMaster.Extensions.Hosting.CommandLine" Version="4.1.1" />
+    <PackageVersion Include="Microsoft.Data.Sqlite" Version="9.0.7" />
    <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="8.0.0" />
-    <PackageVersion Include="Microsoft.Extensions.Hosting" Version="10.0.1" />
-    <PackageVersion Include="QRCoder" Version="1.7.0" />
-    <PackageVersion Include="Serilog.Extensions.Hosting" Version="10.0.0" />
+    <PackageVersion Include="Microsoft.Extensions.Hosting" Version="9.0.7" />
+    <PackageVersion Include="QRCoder" Version="1.6.0" />
+    <PackageVersion Include="Serilog.Extensions.Hosting" Version="9.0.0" />
    <PackageVersion Include="Serilog.Sinks.Async" Version="2.1.0" />
-    <PackageVersion Include="Serilog.Sinks.Console" Version="6.1.1" />
+    <PackageVersion Include="Serilog.Sinks.Console" Version="6.0.0" />
    <PackageVersion Include="Serilog.Sinks.File" Version="7.0.0" />
-    <PackageVersion Include="System.Text.Encoding.CodePages" Version="10.0.1" />
-    <PackageVersion Include="Polly" Version="8.6.5" />
+    <PackageVersion Include="System.Text.Encoding.CodePages" Version="9.0.7" />
+    <PackageVersion Include="Polly" Version="8.6.2" />
    <PackageVersion Include="TagLibSharp" Version="2.3.0" />
-    <PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
+    <PackageVersion Include="Newtonsoft.Json" Version="13.0.3" />
    <PackageVersion Include="NetEscapades.Configuration.Yaml" Version="3.1.0" />
    <PackageVersion Include="MusicDecrypto.Library" Version="2.4.1" />
-    <PackageVersion Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="10.0.1" />
-    <PackageVersion Include="Microsoft.Extensions.Http" Version="10.0.1" />
+    <PackageVersion Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="9.0.7" />
+    <PackageVersion Include="Microsoft.Extensions.Http" Version="9.0.7" />
    <PackageVersion Include="AutoMapper" Version="13.0.1" />
    <PackageVersion Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="12.0.1" />
    <PackageVersion Include="Microsoft.AspNetCore.SpaServices.Extensions" Version="8.0.6" />
@@ -27,10 +32,10 @@
    <PackageVersion Include="SuperSocket.WebSocket" Version="2.0.0-beta.11" />
    <PackageVersion Include="SuperSocket.WebSocket.Server" Version="2.0.0-beta.11" />
    <!-- Testing Projects -->
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
    <PackageVersion Include="Shouldly" Version="4.3.0" />
    <PackageVersion Include="xunit" Version="2.9.3" />
-    <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5">
+    <PackageVersion Include="xunit.runner.visualstudio" Version="2.8.1">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageVersion>
--- a/ZonyLrcTools.sln
+++ b/ZonyLrcTools.sln
@@ -13,6 +13,10 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ZonyLrcTools.Tests", "tests
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ZonyLrcTools.Common", "src\ZonyLrcTools.Common\ZonyLrcTools.Common.csproj", "{9B42E4CA-61AA-4798-8D2B-2D8A7035EB67}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "frontend", "frontend", "{07691E21-94C7-4C9F-970D-B0C77F02B878}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ZonyLrcTools.Api", "src\ZonyLrcTools.Api\ZonyLrcTools.Api.csproj", "{698A1F4D-86F1-4251-B708-9B15648D7245}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -31,6 +35,10 @@ Global
 		{9B42E4CA-61AA-4798-8D2B-2D8A7035EB67}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{9B42E4CA-61AA-4798-8D2B-2D8A7035EB67}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{9B42E4CA-61AA-4798-8D2B-2D8A7035EB67}.Release|Any CPU.Build.0 = Release|Any CPU
+		{698A1F4D-86F1-4251-B708-9B15648D7245}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{698A1F4D-86F1-4251-B708-9B15648D7245}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{698A1F4D-86F1-4251-B708-9B15648D7245}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{698A1F4D-86F1-4251-B708-9B15648D7245}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -42,5 +50,7 @@ Global
 		{55D74323-ABFA-4A73-A3BF-F3E8D5DE6DE8} = {C29FB05C-54B1-4020-94D2-87E192EB2F98}
 		{FFBD3200-568F-455B-8390-5E76C51D522C} = {AF8ADB2F-E46C-4DEE-8316-652D9FE1A69B}
 		{9B42E4CA-61AA-4798-8D2B-2D8A7035EB67} = {C29FB05C-54B1-4020-94D2-87E192EB2F98}
+		{07691E21-94C7-4C9F-970D-B0C77F02B878} = {C29FB05C-54B1-4020-94D2-87E192EB2F98}
+		{698A1F4D-86F1-4251-B708-9B15648D7245} = {C29FB05C-54B1-4020-94D2-87E192EB2F98}
 	EndGlobalSection
 EndGlobal
--- a/src/ZonyLrcTools.Api/Database/DatabaseServiceExtensions.cs
+++ b/src/ZonyLrcTools.Api/Database/DatabaseServiceExtensions.cs
@@ -0,0 +1,19 @@
+using FreeSql;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace ZonyLrcTools.Api.Database;
+
+public static class DatabaseServiceExtensions
+{
+    public static IServiceCollection RegisterDatabaseServices(this IServiceCollection services)
+    {
+        var freeSqlBuilder = new FreeSqlBuilder()
+            .UseConnectionString(DataType.Sqlite, "Data Source=ZonyLrcTools.db;Pooling=true;Max Pool Size=10;")
+            .UseAutoSyncStructure(true);
+
+        var freeSql = freeSqlBuilder.Build();
+        services.AddSingleton(freeSql);
+
+        return services;
+    }
+}
--- a/src/ZonyLrcTools.Api/Domain/Settings/Setting.cs
+++ b/src/ZonyLrcTools.Api/Domain/Settings/Setting.cs
@@ -0,0 +1,30 @@
+using FreeSql.DataAnnotations;
+
+namespace ZonyLrcTools.Api.Domain.Settings;
+
+[Table(Name = "Settings")]
+public class Setting
+{
+    [Column(IsPrimary = true, IsIdentity = true)]
+    public Guid Id { get; set; }
+
+    public string Key { get; protected set; } = null!;
+
+    public string? Value { get; set; }
+
+    public SettingValueType ValueType { get; protected set; }
+
+    public Setting(string key, SettingValueType valueType)
+    {
+        Key = key;
+        ValueType = valueType;
+    }
+}
+
+public enum SettingValueType
+{
+    String = 1,
+    Int = 2,
+    Bool = 3,
+    Double = 4
+}
--- a/src/ZonyLrcTools.Api/Endpoints/Settings/DTOs/GetAllSettingsResponse.cs
+++ b/src/ZonyLrcTools.Api/Endpoints/Settings/DTOs/GetAllSettingsResponse.cs
@@ -0,0 +1,6 @@
+namespace ZonyLrcTools.Api.Endpoints.Settings.DTOs;
+
+public class GetAllSettingsResponse
+{
+    public bool IsAutoCheckUpdate { get; set; }
+}
--- a/src/ZonyLrcTools.Api/Endpoints/Settings/GetAllSettingsEndpoint.cs
+++ b/src/ZonyLrcTools.Api/Endpoints/Settings/GetAllSettingsEndpoint.cs
@@ -0,0 +1,31 @@
+using FastEndpoints;
+using ZonyLrcTools.Api.Domain.Settings;
+using ZonyLrcTools.Api.Endpoints.Settings.DTOs;
+
+namespace ZonyLrcTools.Api.Endpoints.Settings;
+
+public class GetAllSettingsEndpoint(IFreeSql freeSql) : EndpointWithoutRequest<GetAllSettingsResponse>
+{
+    public override void Configure()
+    {
+        Get("/api/settings");
+        AllowAnonymous();
+    }
+
+    public override async Task HandleAsync(CancellationToken ct)
+    {
+        var setting = await freeSql.Select<Setting>()
+            .ToListAsync(ct);
+
+        if (setting.Count == 0)
+        {
+            await Send.NotFoundAsync(ct);
+            return;
+        }
+
+        await Send.OkAsync(new GetAllSettingsResponse
+        {
+            IsAutoCheckUpdate = true
+        }, ct);
+    }
+}
--- a/src/ZonyLrcTools.Api/Program.cs
+++ b/src/ZonyLrcTools.Api/Program.cs
@@ -0,0 +1,23 @@
+using FastEndpoints;
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Hosting;
+using ZonyLrcTools.Api.Database;
+
+namespace ZonyLrcTools.Api;
+
+class Program
+{
+    static async Task Main(string[] args)
+    {
+        var builder = WebApplication.CreateBuilder(args);
+
+        builder.WebHost.ConfigureKestrel(k => k.ListenAnyIP(10086));
+
+        builder.Services.AddFastEndpoints();
+        builder.Services.RegisterDatabaseServices();
+
+        var app = builder.Build();
+        app.UseFastEndpoints();
+        await app.RunAsync();
+    }
+}
--- a/src/ZonyLrcTools.Api/ZonyLrcTools.Api.csproj
+++ b/src/ZonyLrcTools.Api/ZonyLrcTools.Api.csproj
@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net9.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="FastEndpoints" />
+      <PackageReference Include="FastEndpoints.Swagger" />
+      <PackageReference Include="FreeSql" />
+      <PackageReference Include="FreeSql.Provider.SqliteCore" />
+      <PackageReference Include="Microsoft.Data.Sqlite" />
+    </ItemGroup>
+
+</Project>
--- a/src/ZonyLrcTools.Cli/ZonyLrcTools.Cli.csproj
+++ b/src/ZonyLrcTools.Cli/ZonyLrcTools.Cli.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
-        <TargetFramework>net10.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>
        <OutputType>Exe</OutputType>
    </PropertyGroup>

--- a/src/ZonyLrcTools.Cli/publish.sh
+++ b/src/ZonyLrcTools.Cli/publish.sh
@@ -12,9 +12,9 @@ for platform in "${Platforms[@]}"
 do
    dotnet publish -r "$platform" -c Release -p:PublishSingleFile=true -p:DebugType=none --self-contained true || exit 1

-    cd ./bin/Release/net10.0/"$platform"/publish/ || exit 1
+    cd ./bin/Release/net8.0/"$platform"/publish/ || exit 1
    zip -r ./ZonyLrcTools_"$platform"_"${PUBLISH_VERSION}".zip ./ || exit 1
    cd ../../../../../ || exit 1

-    mv ./bin/Release/net10.0/"$platform"/publish/ZonyLrcTools_"$platform"_"$PUBLISH_VERSION".zip ./TempFiles
+    mv ./bin/Release/net8.0/"$platform"/publish/ZonyLrcTools_"$platform"_"$PUBLISH_VERSION".zip ./TempFiles
 done
--- a/src/ZonyLrcTools.Common/ZonyLrcTools.Common.csproj
+++ b/src/ZonyLrcTools.Common/ZonyLrcTools.Common.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
-        <TargetFramework>net10.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>
        <ImplicitUsings>enable</ImplicitUsings>
        <Nullable>enable</Nullable>
    </PropertyGroup>
--- a/tests/ZonyLrcTools.Tests/ZonyLrcTools.Tests.csproj
+++ b/tests/ZonyLrcTools.Tests/ZonyLrcTools.Tests.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
-        <TargetFramework>net10.0</TargetFramework>
+        <TargetFramework>net9.0</TargetFramework>

        <IsPackable>false</IsPackable>
    </PropertyGroup>
--- a/versions/release.md
+++ b/versions/release.md
@@ -4,4 +4,4 @@ Enhancement: None

 Fixed Bugs:  

- [#167] Handle macOS code signing issues. (处理 macOS 代码签名问题。) 
+- 修复了 #156 的问题。