Trong phần này tìm hiểu cách tạo ra thư viên trong C# NET Core, tham chiếu một dự án đến thư viện, chia sẻ thư viện lên nuget.org
Tạo dự án thư viện NET CORE 3
Thư viện trong C# NET Core là một loại dự án code, được xây dựng và build ra để sau này có thể
tích hợp vào các dự án khác. Trong phần này ta sẽ xây dựng một thư viện, trong thư viện
chỉ có một lớp tĩnh cung cấp một vài phương thức để sinh mã HTML, nhằm sinh mã HTML nhanh hơn
trong các ví dụ với ASP.NET. Lớp tĩnh này có tên HtmlHelper, các bước xây dựng như sau:
Tạo ra một thư mục đặt tên htmlhelperlib, trong nó tạo ra thư mục htmlhelper
chứa code dự án, sau đó vào thư mục này thực hiện lệnh để tạo dự án thuộc loại thư viện NET Core
mkdir htmlhelperlib cd htmlhelperlib mkdir htmlhelper
Lệnh khởi tạo dự án, đang trong thư mục htmlhelper gõ lệnh
dotnet new classlib
Sau lệnh này dự án được tạo, mở file .csproj ra và cập nhật các thông tin tại mục
>PropertyGroup> thêm vào gồm:
<TargetFramework>netcoreapp3.1</TargetFramework> <PackageId>XTL.HtmlHelper</PackageId> <Version>1.0.0</Version> <Authors>xuanthulab</Authors> <Company>XUANTHULAB.NET</Company> <GenerateTargetFrameworkAttribute>false</GenerateTargetFrameworkAttribute>
Trong phần PackageID nếu có ý định chia sẻ lên nuget.org thì phải chọn tên duy nhất, không trung với tên các gói đã có trên nuget.org
Tạo ra file HtmlHelper.cs và xây dựng thư viên lớp như sau:
using System.Collections.Generic;
using System.Text;
using Microsoft.AspNetCore.Http;
namespace XTLAB.HtmlHelper {
public static class HtmlHelper {
/// <summary>
/// Phát sinh trang HTML
/// </summary>
/// <param name="title">Tiêu đề trang</param>
/// <param name="content">Nội dung trong thẻ body</param>
/// <returns>Trang HTML</returns>
public static string HtmlDocument (string title, string content) {
return $@"
<!DOCTYPE html>
<html>
<head>
<meta charset=""UTF-8"">
<title>{title}</title>
<link rel=""stylesheet"" href=""/css/site.min.css"" />
<script src=""/js/jquery.min.js"">
</script><script src=""/js/popper.min.js"">
</script><script src=""/js/bootstrap.min.js""></script>
</head>
<body>
{content}
</body>
</html>";
}
/// <summary>
/// Phát sinh HTML thanh menu trên, menu nào active phụ thuộc vào URL mà request gủi đến
/// </summary>
/// <param name="menus">Mảng các menu item, mỗi item có cấu trúc {url, lable}</param>
/// <param name="request">HttpRequest</param>
/// <returns></returns>
public static string MenuTop (object[] menus, HttpRequest request) {
var menubuilder = new StringBuilder ();
menubuilder.Append ("<ul class=\"navbar-nav\">");
foreach (dynamic menu in menus) {
string _class = "nav-item";
// Active khi request.PathBase giống url của menu
if (request.PathBase == menu.url) _class += " active";
menubuilder.Append ($@"
<li class=""{_class}"">
<a class=""nav-link"" href=""{menu.url}"">{menu.label}</a>
</li>
");
}
menubuilder.Append ("</ul>
");
string menuhtml = $@"
<div class=""container"">
<nav class=""navbar navbar-expand-lg navbar-dark mainbackground"">
<a class=""navbar-brand"" href=""/"">XTLAB</a>
<button class=""navbar-toggler"" type=""button""
data-toggle=""collapse"" data-target=""#my-nav-bar""
aria-controls=""my-nav-bar"" aria-expanded=""false"" aria-label=""Toggle navigation"">
<span class=""navbar-toggler-icon""></span>
</button>
<div class=""collapse navbar-collapse"" id=""my-nav-bar"">
{menubuilder}
</div>
</nav></div>";
return menuhtml;
}
/// <summary>
/// Những menu item mặc định cho trang
/// </summary>
/// <returns>Mảng các menuitem</returns>
public static object[] DefaultMenuTopItems () {
return new object[] {
new {
url = "/RequestInfo",
label = "Request"
},
new {
url = "/Form",
label = "Form"
},
new {
url = "/Encoding",
label = "Encoding"
},
new {
url = "/Cookies",
label = "Cookies"
},
new {
url = "/Json",
label = "JSON"
}
};
}
public static string HtmlTrangchu () {
return $@"
<div class=""container"">
<div class=""jumbotron"">
<h1 class=""display-4"">Đây là một trang Web .NET Core</h1>
<p class=""lead"">Trang Web này xây dựng trên nền tảng <code>.NET Core</code>,
chưa sử dụng kỹ thuật MVC - nhằm mục đích học tập.
Mã nguồn trang này tại <a target=""_blank""
href=""https://github.com/xuanthulabnet/learn-cs-netcore/blob/master/ASP_NET_CORE/03.RequestResponse/"">
Mã nguồn Ví dụ</a>
</p>
<hr class=""my-4"">
<p><code>.NET Core</code> là một hệ thống chạy đa nền tảng (Windows, Linux, macOS)</p>
<a class=""btn btn-danger btn-lg"" href=""https://xuanthulab.net/lap-trinh-c-co-ban/"" role=""button"">Xem thêm</a>
</div>
</div>
";
}
// Mở rộng String, phát sinh thẻ HTML với nội dụng là String
// Ví dụ:
// "content".HtmlTag() => <p>content</p>
// "content".HtmlTag("div", "text-danger") => <div class="text-danger">content</div>
public static string HtmlTag (this string content, string tag = "p", string _class = null) {
string cls = (_class != null) ? $" class=\"{_class}\"" : null;
return $"<{tag + cls}>{content}</{tag}>";
}
public static string td (this string content, string _class = null) {
return content.HtmlTag ("td", _class);
}
public static string tr (this string content, string _class = null) {
return content.HtmlTag ("tr", _class);
}
public static string table (this string content, string _class = null) {
return content.HtmlTag ("table", _class);
}
}
}
Để ý, file code có sử dụng namespace Microsoft.AspNetCore.Http, nên cũng cần
tích hợp gói này vào dự án bằng lệnh
dotnet add package Microsoft.AspNetCore.Http
Như vậy bạn đã có một dự án thư viện ở thư mục htmlhelperlib/htmlhelper,
bạn có thể build thử để xuất file thư viện .dll
Thư viện này lớp HtmlHelper ở namespace XTLAB.HtmlHelper
dotnet build
Dự án tham chiếu đến dự án thư viện NET Core
Dự án thư viên trên code đang ở thư mục htmlhelperlib/htmlhelper, ta sẽ tạo
ra một dự án code khác có tham chiếu sử dụng thư viện trên. Giả sử trong thư mục
htmlhelperlib tạo ra một thư mục htmltestcode để khởi tạo là một dự án
console, vào thư mục htmltestcode và thự hiện lệnh:
dotnet new console
Sau đó, đứng ở thư mục htmlhelperlib gõ lệnh sau để tham chiếu sử dụng htmlhelper
dotnet add htmltestcode/htmltestcode.csproj reference htmlhelper/htmlhelper.csproj
Sau lệnh này thấy trong file htmlhelper.csprgj có thông tin:
<ItemGroup>
<ProjectReference Include="..\htmlhelper\htmlhelper.csproj" />
</ItemGroup>
Sử dụng lớp từ thư viện, bạn mở program.cs ra và code thành
using System;
using XTLAB.HtmlHelper; // Sử dụng được namespace từ thư viện HtmlHelper
namespace htmltestcode
{
class Program
{
static void Main(string[] args)
{
// Gọi thử hàm từ HtmlHelper
String html = "Ví dụ sử dụng HtmlHelper".HtmlTag("div", "text-danger");
Console.WriteLine(html);
// Kết quả: <div class="text-danger">Ví dụ sử dụng HtmlHelper</div>
}
}
}
Như vậy bạn đã tham chiếu đến một dự án thư viện, khi build dự án này thì thư viện cũng build theo nếu mã nguồn thư viện cập nhật và chưa build lại.
Chia sẻ thư viện lên Nuget.org
Bạn cần vào trang https://www.nuget.org/ đăng ký một tài khoản và đăng nhập vào.
Truy cập địa chỉ https://www.nuget.org/account/apikeys để lấy API Key.
Bấm vào Create điền các thông tin như key name điền tên do bạn đặt,
Glob Pattern thì điến *, sau đó bấm vào Create.
Khi API Key được tạo, bấm vào copy để lấy, key có dạng như oy2aebwkfhj3jcg5k7aarfahset74gsejnljx42pwabcde
Để chi sẻ thư viện, nó cần biên dịch và đóng gói thành file .nupkg, tại thư mục dự
án bạn gõ lệnh:
dotnet pack
Nó sinh ra file tại đường dẫn htmlhelperlib/htmlhelper/bin/Debug/XTL.HtmlHelper.1.0.0.nupkg
Nếu muốn mỗi lần lệnh dotnet build thì nó đóng gói nupkg luôn thì thêm vào mục
<PropertyGroup>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
Giờ ta tiến hành chia sẻ lên nuget.org,ở thư mục chứa file nupkg gõ lệnh sau:
dotnet nuget push XTL.HtmlHelper.1.0.0.nupkg --api-key qz2jga8pl3dvn2akksyquwcs9ygggg4exypy3bhxy6w6x6 --source https://api.nuget.org/v3/index.json
Nhớ thay chính xác API Key của bạn.
Sau lệnh này, quá trình đẩy lên nuget.org diễn ra, sau đó nuget.org sẽ kiểm tra gói của bạn, nếu nó không chứa mã độc thì sẽ được public (có thể mất hàng giờ kiểm tra) và có thể tải về.
Ví dụ này, sau khi đưa lên nuget.org, ai cũng có thể tích hợp vào code của họ bằng lệnh
dotnet add package XTL.HtmlHelper --version 1.0.0XTL.HtmlHelper
Tham khảo mã nguồn ASP_NET_CORE/htmlhelperlib hoặc tải về ex054
