Створення Sitemap.xml для веб додатка Asp.net Core 7

[ Полезный рекламный блок ]

Попробуйте свои силы в игре, где ваши навыки программирования на C# станут решающим фактором. Переходите по ссылке 🔰.

Розглянемо механізм створення карти сайту. Навряд чи тут можна запропонувати якесь універсальне рішення, все залежить безпосередньо від веб-додатка, від того, як у ньому влаштовано систему маршрутів і посилань, але в принципі можна певною мірою автоматизувати процес створення файлу sitemap.xml.

Для прикладу, створимо простий проект ASP.NET Core Web Application (Веб-додаток ASP.NET Core), який буде отримувати товари з бази даних і міститиме 4 основні дії. Я очікую від вас мінімальні знання концепцій Entity Framework Core, тому в деяких місцях, вдаватися в подробиці не стану.

Генерація sitemap.xml

Конфігурування підключення

Модель і Репозиторій

Конфігурування постачальника бази даних і класу контексту

Добавление контроллера и представления

Створення класу генератора карти

Використання власних маршрутів

Виклад матеріалу в статті буде вестися прискореними темпами, оскільки більша частина роботи стосується генерації sitemap.xml з використанням ASP.NET Core МVС поверх фундаменту, сформованого за допомогою інфраструктури Entity Fгamework Core.

Конфігурування підключення

Для початку завантажимо бібліотеку Entity Framework Core Sql Server:

Install-Package Microsoft.EntityFrameworkCore.SqlServer

1	Install-Package Microsoft.EntityFrameworkCore.SqlServer

Перейдемо у файл appsettings.json і пропишемо конфігурацію підключення та логування:

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=(localdb)\mssqllocaldb;Database=productStore;Trusted_Connection=True;"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Information"
    }
  },
  "AllowedHosts": "*"
}

{

"ConnectionStrings": {

"DefaultConnection": "Server=(localdb)\mssqllocaldb;Database=productStore;Trusted_Connection=True;"

"Logging": {

"LogLevel": {

"Default": "Information",

"Microsoft.AspNetCore": "Information"

}

"AllowedHosts": "*"

}

У забезпеченні доступу до даних у БД інфраструктура Entity Framework Core покладається на клас контексту БД. Щоб забезпечити приклад додатка контекстом, додайте в папку Data файл класу на ім’я ApplicationContext.cs з таким кодом:

public class ApplicationContext : DbContext
    {
        public ApplicationContext(DbContextOptions<ApplicationContext> context) : base(context)
        {
            Database.EnsureDeleted();
            Database.EnsureCreated();
        }

        public DbSet<Product> Products { get; set; }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity<Product>().HasData(
                    new Product { Id = Guid.NewGuid(), Name = "Apple", Category = "Fruits"},
                    new Product { Id = Guid.NewGuid(), Name = "Orange", Category = "Fruits" },
                    new Product { Id = Guid.NewGuid(), Name = "Cherry", Category = "Fruits" }
            );
        }
    }

public class ApplicationContext : DbContext

{

public ApplicationContext(DbContextOptions<ApplicationContext> context) : base(context)

{

Database.EnsureDeleted();

Database.EnsureCreated();

}

public DbSet<Product> Products { get; set; }

protected override void OnModelCreating(ModelBuilder modelBuilder)

{

modelBuilder.Entity<Product>().HasData(

new Product { Id = Guid.NewGuid(), Name = "Apple", Category = "Fruits"},

new Product { Id = Guid.NewGuid(), Name = "Orange", Category = "Fruits" },

new Product { Id = Guid.NewGuid(), Name = "Cherry", Category = "Fruits" }

);

}

Модель і Репозиторій

Модель для додатка GameStore буде заснована на списку товарів. Створіть папку Models і додайте в неї файл класу на ім’я Product.cs з таким вмістом:

public class Product
    {
        public Guid Id { get; set; }
        public string Name { get; set; }
        public string Category { get; set; }
        public decimal Price { get; set; }
    }

public class Product

{

public Guid Id { get; set; }

public string Name { get; set; }

public string Category { get; set; }

public decimal Price { get; set; }

}

Мені подобається забезпечувати узгоджений доступ до даних у застосунку з використанням патерну “Сховище” (Repository), у якому інтерфейс визначає властивості та методи, призначені для доступу до даних, а для роботи з механізмом зберігання даних застосовується клас реалізації. Перевага використання патерну “Сховище” пов’язана з полегшенням модульного тестування частини MVC додатка, а також із тим, що деталі, які стосуються зберігання даних, приховані від інших частин додатка.

Щоб створити інтерфейс сховища, створіть папку Interfaces і додайте в неї файл інтерфейсу на ім’я IProduct.cs із таким вмістом:

public interface IProduct
    {
        Product GetProduct(string productId);
        IEnumerable<string> GetProductsId();
        void AddProduct(Product product); 
    }

public interface IProduct

{

Product GetProduct(string productId);

IEnumerable<string> GetProductsId();

void AddProduct(Product product);

}

Створіть папку Repository і додайте в неї файл класу на ім’я ProductRepository.cs з таким вмістом:

public class ProductRepository : IProduct
    {
        private readonly ApplicationContext _context;

        public ProductRepository(ApplicationContext context)
        {
            _context = context;
        }

        public void AddProduct(Product product)
        {
            _context.Products.Add(product);
            _context.SaveChanges();
        }

        public Product GetProduct(string productId)
        {
            return _context.Products.FirstOrDefault(e => e.Id.ToString() == productId);
        }

        public IEnumerable<string> GetProductsId()
        {
            return _context.Products.Select(e=>e.Id.ToString());
        }
    }

public class ProductRepository : IProduct

{

private readonly ApplicationContext _context;

public ProductRepository(ApplicationContext context)

{

_context = context;

}

public void AddProduct(Product product)

{

_context.Products.Add(product);

_context.SaveChanges();

}

public Product GetProduct(string productId)

{

return _context.Products.FirstOrDefault(e => e.Id.ToString() == productId);

}

public IEnumerable<string> GetProductsId()

{

return _context.Products.Select(e=>e.Id.ToString());

}

У додатку ASP.NET Core MVC, доступ до об’єктів контексту даних управляється з використанням впровадження залежностей, і тому до класу ProductRepository було додано конструктор, який приймає об’єкт ApplicationContext, який буде надано засобом впровадження залежностей під час виконання.

Конфігурування постачальника бази даних і класу контексту

Додайте в клас Program.cs оператори конфігурації, щоб повідомити інфраструктуру Entity Framework Core про те, яким чином використовувати рядок підключення, який має застосовувати постачальник БД, і як керувати класом контексту:

builder.Services.AddTransient<IProduct, ProductRepository>();

IConfigurationRoot _confString = new ConfigurationBuilder().
    SetBasePath(AppDomain.CurrentDomain.BaseDirectory).AddJsonFile("appsettings.json").Build();

builder.Services.AddDbContext<ApplicationContext>(options =>
               options.UseSqlServer(_confString.GetConnectionString("DefaultConnection")));

builder.Services.AddTransient<IProduct, ProductRepository>();

IConfigurationRoot _confString = new ConfigurationBuilder().

SetBasePath(AppDomain.CurrentDomain.BaseDirectory).AddJsonFile("appsettings.json").Build();

builder.Services.AddDbContext<ApplicationContext>(options =>

options.UseSqlServer(_confString.GetConnectionString("DefaultConnection")));

Для простоти прикладу, створення бази даних відбуватиметься без міграцій. Про створення і наповнення бази даних подбає клас контексту ApplicationContext.

Додавання контролера та подання

Змінимо контролер HomeController, додамо такий вміст:

public class HomeController : Controller
    {
        private readonly IProduct _products;

        public HomeController(IProduct products)
        {
            _products = products;
        }

        [HttpGet]
        public ActionResult Index()
        {
            return View();
        }
        [HttpGet]
        public ActionResult Product(string productId)
        {
            var product = _products.GetProduct(productId);
            if (product is not null)
            {
                return Content($"{product.Name}");
            }
            return NotFound();
        }
        [HttpGet]
        public ActionResult About()
        {
            return View();
        }
        [HttpGet]
        public ActionResult Contact()
        {
            return View();
        }
    }

public class HomeController : Controller

{

private readonly IProduct _products;

public HomeController(IProduct products)

{

_products = products;

}

[HttpGet]

public ActionResult Index()

{

return View();

}

[HttpGet]

public ActionResult Product(string productId)

{

var product = _products.GetProduct(productId);

if (product is not null)

{

return Content($"{product.Name}");

}

return NotFound();

}

[HttpGet]

public ActionResult About()

{

return View();

}

[HttpGet]

public ActionResult Contact()

{

return View();

}

Тут у нас чотири методи, крім того, варто зазначити, що метод Product отримує елементи з бд за ID. Таким чином, у базі даних ще можуть зберігатися безліч елементів, для кожного з яких має формуватися свій шлях типу:

https://localhost:7062/home/product?productId=fe438b5a-dad7-4999-8bc7-2d3d7181ac8a

Створення класу генератора карти

Тепер додамо в проєкт новий клас MapGenerator, який генеруватиме файл sitemap.xml:

public static class UrlHelperExtensions
    {
        public static string AbsoluteRouteUrl(this IUrlHelper urlHelper,
            string routeName, object routeValues = null)
        {
            string scheme = urlHelper.ActionContext.HttpContext.Request.Scheme;
            return urlHelper.RouteUrl(routeName, routeValues, scheme);
        }
    }
    public class MapGenerator
    {
        private readonly IProduct _products;

        public MapGenerator(IProduct products)
        {
            _products = products;
        }

        public IReadOnlyCollection<string> GetSitemapNodes(IUrlHelper urlHelper)
        {
            string scheme = urlHelper.ActionContext.HttpContext.Request.Scheme;
            List<string> nodes = new List<string>();

            nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Index" }));
            nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "About" }));
            nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Contact" }));

            foreach (string productId in _products.GetProductsId())
            {
                nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Product", id = productId }));
            }

            return nodes;
        }
        public string GetSitemapDocument(IEnumerable<string> sitemapNodes)
        {
            XNamespace xmlns = "http://www.sitemaps.org/schemas/sitemap/0.9";
            XElement root = new XElement(xmlns + "urlset");

            foreach (string sitemapNode in sitemapNodes)
            {
                XElement urlElement = new XElement(
                    xmlns + "url",
                    new XElement(xmlns + "loc", Uri.EscapeUriString(sitemapNode)));
                root.Add(urlElement);
            }

            XDocument document = new XDocument(root);
            return document.ToString();
        }
    }

public static class UrlHelperExtensions

{

public static string AbsoluteRouteUrl(this IUrlHelper urlHelper,

string routeName, object routeValues = null)

{

string scheme = urlHelper.ActionContext.HttpContext.Request.Scheme;

return urlHelper.RouteUrl(routeName, routeValues, scheme);

}

public class MapGenerator

{

private readonly IProduct _products;

public MapGenerator(IProduct products)

{

_products = products;

}

public IReadOnlyCollection<string> GetSitemapNodes(IUrlHelper urlHelper)

{

string scheme = urlHelper.ActionContext.HttpContext.Request.Scheme;

List<string> nodes = new List<string>();

nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Index" }));

nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "About" }));

nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Contact" }));

foreach (string productId in _products.GetProductsId())

{

nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Product", id = productId }));

}

return nodes;

}

public string GetSitemapDocument(IEnumerable<string> sitemapNodes)

{

XNamespace xmlns = "http://www.sitemaps.org/schemas/sitemap/0.9";

XElement root = new XElement(xmlns + "urlset");

foreach (string sitemapNode in sitemapNodes)

{

XElement urlElement = new XElement(

xmlns + "url",

new XElement(xmlns + "loc", Uri.EscapeUriString(sitemapNode)));

root.Add(urlElement);

}

XDocument document = new XDocument(root);

return document.ToString();

}

Для спрощення створення посилання за маршрутом і його параметрами тут визначено метод розширення AbsoluteRouteUrl, який приймає назву маршруту і його параметри.

Метод GetSitemapNodes() класу MapGenerator генерує всі посилання за методами контролера. Для отримання всіх id товарів із бази даних застосовується допоміжний сервіс, який дістає їх із таблиці Products.

У класі Program.cs додамо сервіс:

builder.Services.AddTransient<MapGenerator>();

1	builder.Services.AddTransient<MapGenerator>();

У HomeController, отримаємо його:

private readonly IProduct _products;
        private readonly MapGenerator _generator;

        public HomeController(IProduct products, MapGenerator generator)
        {
            _products = products;
            _generator = generator;
        }

private readonly IProduct _products;

private readonly MapGenerator _generator;

public HomeController(IProduct products, MapGenerator generator)

{

_products = products;

_generator = generator;

}

Тепер додамо в HomeController метод, який віддаватиме згенеровану карту сайту:

[Route("/sitemap.xml")]
        public ActionResult SitemapXml()
        {
            var result = _generator.GetSitemapNodes(this.Url);
            string host = Request.Scheme + "://" + Request.Host;

            var sitemapNodes = _generator.GetSitemapNodes(this.Url);
            string xml = _generator.GetSitemapDocument(sitemapNodes);
            return this.Content(xml, "text/xml", Encoding.UTF8);
        }

[Route("/sitemap.xml")]

public ActionResult SitemapXml()

{

var result = _generator.GetSitemapNodes(this.Url);

string host = Request.Scheme + "://" + Request.Host;

var sitemapNodes = _generator.GetSitemapNodes(this.Url);

string xml = _generator.GetSitemapDocument(sitemapNodes);

return this.Content(xml, "text/xml", Encoding.UTF8);

}

І тепер при зверненні шляхом https://localhost:XXXX/sitemap.xml ми отримаємо згенеровану карту:

Использование собственных маршрутов

Фреймворк MVC дає змогу використовувати в додатку маршрутизацію на основі атрибутів. Ми можемо вказати власні маршрути для кожної дії нашого контролера, як ми зробили до цього для дії SitemapXml().

Якщо поглянути на карту сайту, поточний шлях отримання продукту виглядає не дуже, давайте визначимо власний маршрут для отримання товару:

[HttpGet]
        [Route("product")]
        public ActionResult Product(string productId)
        {
            var product = _products.GetProduct(productId);
            if (product is not null)
            {
                return Content($"{product.Name}");
            }
            return NotFound();
        }

[HttpGet]

[Route("product")]

public ActionResult Product(string productId)

{

var product = _products.GetProduct(productId);

if (product is not null)

{

return Content($"{product.Name}");

}

return NotFound();

}

Тепер, крім стандартного маршруту, необхідно визначити свій, для цього в класі Program.cs додамо такий рядок:

app.MapControllerRoute(
    name: "myroute",
    pattern: "{route}/{id?}");

app.MapControllerRoute(

name: "myroute",

pattern: "{route}/{id?}");

У класі MapGenerator, змінимо реалізацію методу GetSitemapNodes:

public IReadOnlyCollection<string> GetSitemapNodes(IUrlHelper urlHelper)
        {
            string scheme = urlHelper.ActionContext.HttpContext.Request.Scheme;
            List<string> nodes = new List<string>();

            nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Index" }));
            nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "About" }));
            nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Contact" }));

            foreach (string productId in _products.GetProductsId())
            {
                nodes.Add(urlHelper.AbsoluteRouteUrl("myroute", new { route = "product", id = productId }));
            }

            return nodes;
        }

public IReadOnlyCollection<string> GetSitemapNodes(IUrlHelper urlHelper)

{

string scheme = urlHelper.ActionContext.HttpContext.Request.Scheme;

List<string> nodes = new List<string>();

nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Index" }));

nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "About" }));

nodes.Add(urlHelper.AbsoluteRouteUrl("Default", new { controller = "Home", action = "Contact" }));

foreach (string productId in _products.GetProductsId())

{

nodes.Add(urlHelper.AbsoluteRouteUrl("myroute", new { route = "product", id = productId }));

}

return nodes;

}

Перейдемо шляхом https://localhost:XXXX/sitemap.xml і отримаємо згенеровану карту з новими маршрутами:

На цьому стаття “Створення Sitemap.xml для веб додатка Asp.net Core 7”, підійшла до кінця, сподіваюся вам було цікаво. Ви можете завантажити вихідний код у моєму репозиторії — Github.

Поділіться вашим досвідом у коментарях, як ви генеруєте sitemap.xml в Asp.Net Core або інших типах проектів?

Так само вам може бути цікава попередня стаття:

Checkbox List в Asp.net Core Mvc

Ви хочете навчитися писати код мовою програмування C#?

Створювати різні інформаційні системи, що складаються з сайтів, мобільних клієнтів, десктопних додатків, телеграм-ботів тощо.

Переходьте до нас на сторінку Dijix і ознайомтеся з умовами навчання, ми спеціалізуємося тільки на індивідуальних заняттях, як для початківців, так і для просунутих програмістів. Ви можете взяти як одне заняття для опрацювання питання, що вас цікавить, так і кілька, для більш щільної роботи. Завдяки особистому кабінету, кожен студент підвищить якість свого навчання, у вашому розпорядженні: