github/ZonyLrcToolsX
1
0
Fork 0
mirror of https://github.com/real-zony/ZonyLrcToolsX.git synced 2025-07-01 12:11:13 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: Use Object to replace byte arrays when generating lyrics.

Browse Source
This commit is contained in:
real-zony 2022-10-28 10:13:14 +08:00
parent b7b1f36bf5
commit 5d1e90f638
14 changed files with 37 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/ZonyLrcTools.Common/Lyrics/ILyricsItemCollectionFactory.cs
View File

@ -10,7 +10,7 @@ namespace ZonyLrcTools.Common.Lyrics
/// </summary>
/// <param name="sourceLyric">原始歌词数据。</param>
/// <returns>构建完成的 <see cref="LyricsItemCollection"/> 对象。</returns>
LyricsItemCollection Build(string sourceLyric);
LyricsItemCollection Build(string? sourceLyric);
/// <summary>
/// 根据指定的歌曲数据构建新的 <see cref="LyricsItemCollection"/> 实例。

2
src/ZonyLrcTools.Common/Lyrics/ILyricsProvider.cs
View File

@ -12,7 +12,7 @@ namespace ZonyLrcTools.Common.Lyrics
/// <param name="artist">歌曲的作者。</param>
/// <param name="duration">歌曲的时长。</param>
/// <returns>歌曲的歌词数据对象。</returns>
ValueTask<LyricsItemCollection> DownloadAsync(string songName, string artist, long? duration = null);
ValueTask<LyricsItemCollection> DownloadAsync(string? songName, string? artist, long? duration = null);
/// <summary>
/// 下载器的名称。

4
src/ZonyLrcTools.Common/Lyrics/LyricsItemCollection.cs
View File

@ -14,9 +14,9 @@ namespace ZonyLrcTools.Common.Lyrics
/// </summary>
public bool IsPruneMusic => Count == 0;
public GlobalLyricsConfigOptions Options { get; private set; }
public GlobalLyricsConfigOptions? Options { get; private set; }
public LyricsItemCollection(GlobalLyricsConfigOptions options)
public LyricsItemCollection(GlobalLyricsConfigOptions? options)
{
Options = options;
}

2
src/ZonyLrcTools.Common/Lyrics/LyricsItemCollectionFactory.cs
View File

@ -17,7 +17,7 @@ namespace ZonyLrcTools.Common.Lyrics
_options = options.Value;
}
public LyricsItemCollection Build(string sourceLyric)
public LyricsItemCollection Build(string? sourceLyric)
{
var lyric = new LyricsItemCollection(_options.Provider.Lyric.Config);
if (string.IsNullOrEmpty(sourceLyric))

13
src/ZonyLrcTools.Common/Lyrics/LyricsProvider.cs
View File

@ -21,8 +21,8 @@ namespace ZonyLrcTools.Common.Lyrics
{
var args = new LyricsProviderArgs(songName, artist, duration ?? 0);
await ValidateAsync(args);
var downloadDataBytes = await DownloadDataAsync(args);
return await GenerateLyricAsync(downloadDataBytes, args);
var downloadDataObject = await DownloadDataAsync(args);
return await GenerateLyricAsync(downloadDataObject, args);
}
/// <summary>
@ -47,12 +47,13 @@ namespace ZonyLrcTools.Common.Lyrics
/// <summary>
/// 根据指定的歌曲参数，下载歌词数据。
/// </summary>
protected abstract ValueTask<byte[]> DownloadDataAsync(LyricsProviderArgs args);
protected abstract ValueTask<object> DownloadDataAsync(LyricsProviderArgs args);
/// <summary>
/// 根据指定的歌词二进制数据，生成歌词数据。
/// 根据指定的歌词对象，生成歌词数据，常用于处理不同格式的歌词数据。
/// </summary>
/// <param name="data">歌词的原始二进制数据。</param>
protected abstract ValueTask<LyricsItemCollection> GenerateLyricAsync(byte[] data, LyricsProviderArgs args);
/// <param name="lyricsObject">当 <see cref="DownloadDataAsync"/> 完成后，传递的歌词数据对象。</param>
/// <param name="args">生成歌词时，提供的歌曲信息参数。</param>
protected abstract ValueTask<LyricsItemCollection> GenerateLyricAsync(object lyricsObject, LyricsProviderArgs args);
}
}

10
src/ZonyLrcTools.Common/Lyrics/Providers/KuGou/KuGourLyricsProvider.cs
View File

@ -29,7 +29,7 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.KuGou
_options = options.Value;
}
protected override async ValueTask<byte[]> DownloadDataAsync(LyricsProviderArgs args)
protected override async ValueTask<object> DownloadDataAsync(LyricsProviderArgs args)
{
var searchResult = await _warpHttpClient.GetAsync<SongSearchResponse>(KuGouSearchMusicUrl,
new SongSearchRequest(args.SongName, args.Artist, _options.Provider.Lyric.GetLyricProviderOption(DownloaderName).Depth));
@ -41,16 +41,14 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.KuGou
new GetLyricAccessKeyRequest(searchResult.Data.List[0].FileHash));
var accessKeyObject = accessKeyResponse.AccessKeyDataObjects[0];
var lyricResponse = await _warpHttpClient.GetAsync(KuGouGetLyricUrl,
return await _warpHttpClient.GetAsync(KuGouGetLyricUrl,
new GetLyricRequest(accessKeyObject.Id, accessKeyObject.AccessKey));
return Encoding.UTF8.GetBytes(lyricResponse);
}
protected override async ValueTask<LyricsItemCollection> GenerateLyricAsync(byte[] data, LyricsProviderArgs args)
protected override async ValueTask<LyricsItemCollection> GenerateLyricAsync(object data, LyricsProviderArgs args)
{
await ValueTask.CompletedTask;
var lyricJsonObj = JObject.Parse(Encoding.UTF8.GetString(data));
var lyricJsonObj = JObject.Parse((data as string)!);
if (lyricJsonObj.SelectToken("$.status").Value<int>() != 200)
{
throw new ErrorCodeException(ErrorCodes.NoMatchingSong, attachObj: args);

8
src/ZonyLrcTools.Common/Lyrics/Providers/KuWo/KuWoLyricsProvider.cs
View File

@ -32,7 +32,7 @@ public class KuWoLyricsProvider : LyricsProvider
_options = options.Value;
}
protected override async ValueTask<byte[]> DownloadDataAsync(LyricsProviderArgs args)
protected override async ValueTask<object> DownloadDataAsync(LyricsProviderArgs args)
{
var songSearchResponse = await _warpHttpClient.GetAsync<SongSearchResponse>(KuWoSearchMusicUrl,
new SongSearchRequest(args.SongName, args.Artist, pageSize: _options.Provider.Lyric.GetLyricProviderOption(DownloaderName).Depth),
@ -46,18 +46,16 @@ public class KuWoLyricsProvider : LyricsProvider
ValidateSongSearchResponse(songSearchResponse, args);
var songLyricsResponse = await _warpHttpClient.GetAsync<GetLyricsResponse>(KuWoSearchLyricsUrl,
return await _warpHttpClient.GetAsync<GetLyricsResponse>(KuWoSearchLyricsUrl,
new GetLyricsRequest(songSearchResponse.GetMatchedMusicId(args.SongName, args.Artist, args.Duration)),
op =>
{
op.Headers.UserAgent.Add(UserAgent);
op.Headers.Referrer = new Uri("https://m.kuwo.cn/yinyue/");
});
return Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(songLyricsResponse.Lyrics));
}
protected override ValueTask<LyricsItemCollection> GenerateLyricAsync(byte[] data, LyricsProviderArgs args)
protected override ValueTask<LyricsItemCollection> GenerateLyricAsync(object lyricsObject, LyricsProviderArgs args)
{
throw new NotImplementedException();
}

15
src/ZonyLrcTools.Common/Lyrics/Providers/NetEase/NetEaseLyricsProvider.cs
View File

@ -1,5 +1,4 @@
using System.Net.Http.Headers;
using System.Text;
using Microsoft.Extensions.Options;
using Newtonsoft.Json;
using ZonyLrcTools.Common.Configuration;
@ -32,7 +31,7 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.NetEase
_options = options.Value;
}
protected override async ValueTask<byte[]> DownloadDataAsync(LyricsProviderArgs args)
protected override async ValueTask<object> DownloadDataAsync(LyricsProviderArgs args)
{
var searchResult = await _warpHttpClient.PostAsync<SongSearchResponse>(
NetEaseSearchMusicUrl,
@ -49,19 +48,17 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.NetEase
ValidateSongSearchResponse(searchResult, args);
var lyricResponse = await _warpHttpClient.GetAsync(
return await _warpHttpClient.GetAsync(
NetEaseGetLyricUrl,
new GetLyricRequest(searchResult.GetFirstMatchSongId(args.SongName, args.Duration)),
msg => msg.Headers.Referrer = new Uri(NetEaseRequestReferer));
return Encoding.UTF8.GetBytes(lyricResponse);
}
protected override async ValueTask<LyricsItemCollection> GenerateLyricAsync(byte[] data, LyricsProviderArgs args)
protected override async ValueTask<LyricsItemCollection> GenerateLyricAsync(object lyricsObject, LyricsProviderArgs args)
{
await ValueTask.CompletedTask;
var json = JsonConvert.DeserializeObject<GetLyricResponse>(Encoding.UTF8.GetString(data));
var json = JsonConvert.DeserializeObject<GetLyricResponse>((lyricsObject as string)!);
if (json?.OriginalLyric == null || string.IsNullOrEmpty(json.OriginalLyric.Text))
{
return new LyricsItemCollection(null);
@ -73,8 +70,8 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.NetEase
}
return _lyricsItemCollectionFactory.Build(
json.OriginalLyric?.Text,
json.TranslationLyric?.Text);
json.OriginalLyric.Text,
json.TranslationLyric.Text);
}
protected virtual void ValidateSongSearchResponse(SongSearchResponse response, LyricsProviderArgs args)

4
src/ZonyLrcTools.Common/Lyrics/Providers/QQMusic/JsonModel/GetLyricRequest.cs
View File

@ -6,7 +6,7 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.QQMusic.JsonModel
{
[JsonProperty("nobase64")] public int IsNoBase64Encoding { get; set; }
[JsonProperty("songmid")] public string SongId { get; set; }
[JsonProperty("songmid")] public string? SongId { get; set; }
[JsonProperty("platform")] public string ClientPlatform { get; set; }
@ -20,7 +20,7 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.QQMusic.JsonModel
{
}
public GetLyricRequest(string songId)
public GetLyricRequest(string? songId)
{
IsNoBase64Encoding = 1;
SongId = songId;

11
src/ZonyLrcTools.Common/Lyrics/Providers/QQMusic/QQLyricsProvider.cs
View File

@ -1,4 +1,3 @@
using System.Text;
using System.Web;
using Newtonsoft.Json.Linq;
using ZonyLrcTools.Common.Infrastructure.Exceptions;
@ -27,7 +26,7 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.QQMusic
_lyricsItemCollectionFactory = lyricsItemCollectionFactory;
}
protected override async ValueTask<byte[]> DownloadDataAsync(LyricsProviderArgs args)
protected override async ValueTask<object> DownloadDataAsync(LyricsProviderArgs args)
{
var searchResult = await _warpHttpClient.GetAsync<SongSearchResponse>(
QQSearchMusicUrl,
@ -35,18 +34,16 @@ namespace ZonyLrcTools.Common.Lyrics.Providers.QQMusic
ValidateSongSearchResponse(searchResult, args);
var lyricJsonString = await _warpHttpClient.GetAsync(QQGetLyricUrl,
return await _warpHttpClient.GetAsync(QQGetLyricUrl,
new GetLyricRequest(searchResult.Data.Song.SongItems.FirstOrDefault()?.SongId),
op => op.Headers.Referrer = new Uri(QQMusicRequestReferer));
return Encoding.UTF8.GetBytes(lyricJsonString);
}
protected override async ValueTask<LyricsItemCollection> GenerateLyricAsync(byte[] data, LyricsProviderArgs args)
protected override async ValueTask<LyricsItemCollection> GenerateLyricAsync(object lyricsObject, LyricsProviderArgs args)
{
await ValueTask.CompletedTask;
var lyricJsonString = Encoding.UTF8.GetString(data);
var lyricJsonString = (lyricsObject as string)!;
lyricJsonString = lyricJsonString.Replace(@"MusicJsonCallback(", string.Empty).TrimEnd(')');
if (lyricJsonString.Contains("\"code\":-1901"))

1
tests/ZonyLrcTools.Tests/Infrastructure/Lyrics/KuGouLyricProviderTests.cs
View File

@ -18,6 +18,7 @@ namespace ZonyLrcTools.Tests.Infrastructure.Lyrics
}
[Fact]
[Trait("LyricsProvider", "KuGou")]
public async Task DownloadAsync_Test()
{
var lyric = await _lyricsProvider.DownloadAsync("东方红", null);

1
tests/ZonyLrcTools.Tests/Infrastructure/Lyrics/KuWoLyricsProviderTests.cs
View File

@ -18,6 +18,7 @@ public class KuWoLyricsProviderTests : TestBase
}
[Fact]
[Trait("LyricsProvider ", "KuGou")]
public async Task DownloadAsync_Test()
{
var lyric = await _kuwoLyricsProvider.DownloadAsync("告白气球", "周杰伦");

3
tests/ZonyLrcTools.Tests/Infrastructure/Lyrics/NetEaseLyricsProviderTests.cs
View File

@ -21,6 +21,7 @@ namespace ZonyLrcTools.Tests.Infrastructure.Lyrics
}
[Fact]
[Trait("LyricsProvider ", "NetEase")]
public async Task DownloadAsync_Test()
{
var lyric = await _lyricsProvider.DownloadAsync("Hollow", "Janet Leon");
@ -93,7 +94,7 @@ namespace ZonyLrcTools.Tests.Infrastructure.Lyrics
{
var options = ServiceProvider.GetRequiredService<IOptions<GlobalOptions>>();
options.Value.Provider.Lyric.Config.IsOnlyOutputTranslation = true;
var lyric = await _lyricsProvider.DownloadAsync("Bones", "Image Dragons");
lyric.ToString().ShouldNotContain("Gimme, gimme, gimme some time to think");
}

3
tests/ZonyLrcTools.Tests/Infrastructure/Lyrics/QQLyricsProviderTests.cs
View File

@ -18,13 +18,14 @@ namespace ZonyLrcTools.Tests.Infrastructure.Lyrics
}
[Fact]
[Trait("LyricsProvider", "QQ")]
public async Task DownloadAsync_Test()
{
var lyric = await _lyricsProvider.DownloadAsync("东风破", "周杰伦");
lyric.ShouldNotBeNull();
lyric.IsPruneMusic.ShouldBe(false);
}
// About the new feature mentioned in issue #87.
// Github Issue: https://github.com/real-zony/ZonyLrcToolsX/issues/87
[Fact]