C# .NET ASP WEB API. Нексогональная архитектура. Как сделать эти классы? В папке…
- User
C# .NET ASP WEB API. Нексогональная архитектура. Как сделать эти классы? В папке Domain/Models? Вот код: [-- Таблица пользователей CREATE TABLE users ( user_id SERIAL PRIMARY KEY, username VARCHAR(50) UNIQUE NOT NULL, email VARCHAR(100) UNIQUE NOT NULL, password_hash VARCHAR(255) NOT NULL, registration_date TIMESTAMP DEFAULT NOW(), first_name VARCHAR(50), last_name VARCHAR(50), phone VARCHAR(20) );
-- Таблица статусов запчастей CREATE TABLE part_status ( status_id SERIAL PRIMARY KEY, status_name VARCHAR(50) UNIQUE NOT NULL );
-- Вставка возможных статусов INSERT INTO part_status (status_name) VALUES ('доступна'), ('обменяна'), ('продана'), ('запрос на обмен');
-- Таблица типов двигателей CREATE TABLE engine_types ( engine_type_id SERIAL PRIMARY KEY, engine_type_name VARCHAR(50) UNIQUE NOT NULL );
-- Вставка типов двигателей INSERT INTO engine_types (engine_type_name) VALUES ('Бензиновый'), ('Дизельный'), ('Гибридный'), ('Электрический');
-- Таблица трансмиссий CREATE TABLE transmissions ( transmission_id SERIAL PRIMARY KEY, transmission_type_name VARCHAR(50) UNIQUE NOT NULL );
-- Вставка типов трансмиссий INSERT INTO transmissions (transmission_type_name) VALUES ('Механическая'), ('Автоматическая'), ('Вариатор'), ('Роботизированная');
-- Таблица автомобилей пользователя CREATE TABLE cars ( car_id SERIAL PRIMARY KEY, user_id INTEGER REFERENCES users(user_id) ON DELETE CASCADE, make VARCHAR(50) NOT NULL, -- Марка автомобиля model VARCHAR(50) NOT NULL, -- Модель автомобиля year SMALLINT, -- Год выпуска engine_type_id INTEGER REFERENCES engine_types(engine_type_id), transmission_id INTEGER REFERENCES transmissions(transmission_id) );
-- Таблица запчастей CREATE TABLE parts ( part_id SERIAL PRIMARY KEY, user_id INTEGER REFERENCES users(user_id) ON DELETE CASCADE, car_id INTEGER REFERENCES cars(car_id) ON DELETE SET NULL, part_name VARCHAR(100) NOT NULL, description TEXT, condition VARCHAR(50), availability_status INTEGER REFERENCES part_status(status_id), -- Использование числового статуса posting_date TIMESTAMP DEFAULT NOW() );
-- Таблица услуг CREATE TABLE services ( service_id SERIAL PRIMARY KEY, user_id INTEGER REFERENCES users(user_id) ON DELETE CASCADE, service_name VARCHAR(100) NOT NULL, description TEXT, offer_or_request VARCHAR(10) CHECK (offer_or_request IN ('offer', 'request')), -- 'offer' для предложений, 'request' для запросов status VARCHAR(20), posting_date TIMESTAMP DEFAULT NOW() );
-- Таблица диалогов для общения между пользователями CREATE TABLE conversations ( conversation_id SERIAL PRIMARY KEY );
-- Таблица сообщений CREATE TABLE messages ( message_id SERIAL PRIMARY KEY, conversation_id INTEGER REFERENCES conversations(conversation_id) ON DELETE CASCADE, sender_user_id INTEGER REFERENCES users(user_id) ON DELETE CASCADE, message_text TEXT NOT NULL, timestamp TIMESTAMP DEFAULT NOW() );
-- Таблица участников диалога CREATE TABLE conversation_participants ( conversation_id INTEGER REFERENCES conversations(conversation_id) ON DELETE CASCADE, user_id INTEGER REFERENCES users(user_id) ON DELETE CASCADE, PRIMARY KEY (conversation_id, user_id) );
-- Таблица отчетов (фото и видео) CREATE TABLE reports ( report_id SERIAL PRIMARY KEY, user_id INTEGER REFERENCES users(user_id) ON DELETE CASCADE, title VARCHAR(200) NOT NULL, description TEXT, content_url TEXT NOT NULL, -- Ссылка на файл фото или видео timestamp TIMESTAMP DEFAULT NOW() );
-- Таблица комментариев к отчетам CREATE TABLE comments ( comment_id SERIAL PRIMARY KEY, report_id INTEGER REFERENCES reports(report_id) ON DELETE CASCADE, user_id INTEGER REFERENCES users(user_id) ON DELETE CASCADE, comment_text TEXT NOT NULL, timestamp TIMESTAMP DEFAULT NOW() );
-- Таблица уведомлений CREATE TABLE notifications ( notification_id SERIAL PRIMARY KEY, user_id INTEGER REFERENCES users(user_id) ON DELETE CASCADE, notification_type VARCHAR(50), -- Например, 'interest_in_part', 'interest_in_service' reference_id INTEGER, -- Идентификатор связанного элемента (part_id, service_id и т.д.) created_at TIMESTAMP DEFAULT NOW(), read_status BOOLEAN DEFAULT FALSE ); ]
- Assistant
В Clean Architecture (Чистой архитектуре) важно разделять бизнес-логику от инфраструктурных деталей, таких как доступ к данным или представление. Ваши классы моделей, соответствующие таблицам базы данных, должны находиться в Domain Layer (доменный слой), обычно в папке
Domain/Models. Этот слой содержит основные сущности (entities) и бизнес-логику, которые не зависят от других слоев.Ниже приведены шаги и примеры создания классов на основе предоставленного SQL-схемы:
1. Организация слоёв проекта
Типичная структура проекта с Clean Architecture может выглядеть следующим образом:
- Domain: Содержит модели, интерфейсы и бизнес-логику.
Domain/ModelsDomain/Interfaces
- Application: Содержит сервисы, обработчики команд и запросов.
- Infrastructure: Содержит реализацию интерфейсов, доступ к базе данных и внешним сервисам.
- Presentation: В вашем случае ASP.NET Web API контроллеры.
2. Создание моделей в Domain/Models
Приведу примеры моделей на основе ваших таблиц:
2.1. Пользователи (
users)namespace YourProject.Domain.Models { public class User { public int UserId { get; set; } // Соответствует user_id public string Username { get; set; } // username public string Email { get; set; } // email public string PasswordHash { get; set; } // password_hash public DateTime RegistrationDate { get; set; } = DateTime.UtcNow; // registration_date public string FirstName { get; set; } // first_name public string LastName { get; set; } // last_name public string Phone { get; set; } // phone // Навигационные свойства public ICollection<Car> Cars { get; set; } public ICollection<Part> Parts { get; set; } public ICollection<Service> Services { get; set; } public ICollection<Report> Reports { get; set; } public ICollection<Comment> Comments { get; set; } public ICollection<Notification> Notifications { get; set; } public ICollection<Message> Messages { get; set; } public ICollection<ConversationParticipant> ConversationParticipants { get; set; } } }2.2. Статусы запчастей (
part_status)namespace YourProject.Domain.Models { public class PartStatus { public int StatusId { get; set; } // status_id public string StatusName { get; set; } // status_name // Навигационное свойство public ICollection<Part> Parts { get; set; } } }2.3. Типы двигателей (
engine_types)namespace YourProject.Domain.Models { public class EngineType { public int EngineTypeId { get; set; } // engine_type_id public string EngineTypeName { get; set; } // engine_type_name // Навигационное свойство public ICollection<Car> Cars { get; set; } } }2.4. Трансмиссии (
transmissions)namespace YourProject.Domain.Models { public class Transmission { public int TransmissionId { get; set; } // transmission_id public string TransmissionTypeName { get; set; } // transmission_type_name // Навигационное свойство public ICollection<Car> Cars { get; set; } } }2.5. Автомобили пользователя (
cars)namespace YourProject.Domain.Models { public class Car { public int CarId { get; set; } // car_id public int UserId { get; set; } // user_id public string Make { get; set; } // make public string Model { get; set; } // model public short? Year { get; set; } // year public int? EngineTypeId { get; set; } // engine_type_id public int? TransmissionId { get; set; } // transmission_id // Навигационные свойства public User User { get; set; } public EngineType EngineType { get; set; } public Transmission Transmission { get; set; } public ICollection<Part> Parts { get; set; } } }2.6. Запчасти (
parts)namespace YourProject.Domain.Models { public class Part { public int PartId { get; set; } // part_id public int UserId { get; set; } // user_id public int? CarId { get; set; } // car_id public string PartName { get; set; } // part_name public string Description { get; set; } // description public string Condition { get; set; } // condition public int? AvailabilityStatus { get; set; } // availability_status public DateTime PostingDate { get; set; } = DateTime.UtcNow; // posting_date // Навигационные свойства public User User { get; set; } public Car Car { get; set; } public PartStatus PartStatus { get; set; } } }2.7. Услуги (
services)namespace YourProject.Domain.Models { public class Service { public int ServiceId { get; set; } // service_id public int UserId { get; set; } // user_id public string ServiceName { get; set; } // service_name public string Description { get; set; } // description public string OfferOrRequest { get; set; } // offer_or_request public string Status { get; set; } // status public DateTime PostingDate { get; set; } = DateTime.UtcNow; // posting_date // Навигационные свойства public User User { get; set; } } }2.8. Диалоги и сообщения (
conversations,messages,conversation_participants)namespace YourProject.Domain.Models { public class Conversation { public int ConversationId { get; set; } // conversation_id // Навигационные свойства public ICollection<ConversationParticipant> ConversationParticipants { get; set; } public ICollection<Message> Messages { get; set; } } public class ConversationParticipant { public int ConversationId { get; set; } // conversation_id public int UserId { get; set; } // user_id // Навигационные свойства public Conversation Conversation { get; set; } public User User { get; set; } } public class Message { public int MessageId { get; set; } // message_id public int ConversationId { get; set; } // conversation_id public int SenderUserId { get; set; } // sender_user_id public string MessageText { get; set; } // message_text public DateTime Timestamp { get; set; } = DateTime.UtcNow; // timestamp // Навигационные свойства public Conversation Conversation { get; set; } public User Sender { get; set; } } }2.9. Отчеты и комментарии (
reports,comments)namespace YourProject.Domain.Models { public class Report { public int ReportId { get; set; } // report_id public int UserId { get; set; } // user_id public string Title { get; set; } // title public string Description { get; set; } // description public string ContentUrl { get; set; } // content_url public DateTime Timestamp { get; set; } = DateTime.UtcNow; // timestamp // Навигационные свойства public User User { get; set; } public ICollection<Comment> Comments { get; set; } } public class Comment { public int CommentId { get; set; } // comment_id public int ReportId { get; set; } // report_id public int UserId { get; set; } // user_id public string CommentText { get; set; } // comment_text public DateTime Timestamp { get; set; } = DateTime.UtcNow; // timestamp // Навигационные свойства public Report Report { get; set; } public User User { get; set; } } }2.10. Уведомления (
notifications)namespace YourProject.Domain.Models { public class Notification { public int NotificationId { get; set; } // notification_id public int UserId { get; set; } // user_id public string NotificationType { get; set; } // notification_type public int? ReferenceId { get; set; } // reference_id public DateTime CreatedAt { get; set; } = DateTime.UtcNow; // created_at public bool ReadStatus { get; set; } = false; // read_status // Навигационные свойства public User User { get; set; } } }3. Настройка контекста базы данных (DbContext)
В Infrastructure Layer создайте
ApplicationDbContext, наследующий отDbContextи включающий DbSet для каждой модели:using Microsoft.EntityFrameworkCore; using YourProject.Domain.Models; namespace YourProject.Infrastructure.Data { public class ApplicationDbContext : DbContext { public ApplicationDbContext(DbContextOptions<ApplicationDbContext> options) : base(options) { } public DbSet<User> Users { get; set; } public DbSet<PartStatus> PartStatuses { get; set; } public DbSet<EngineType> EngineTypes { get; set; } public DbSet<Transmission> Transmissions { get; set; } public DbSet<Car> Cars { get; set; } public DbSet<Part> Parts { get; set; } public DbSet<Service> Services { get; set; } public DbSet<Conversation> Conversations { get; set; } public DbSet<ConversationParticipant> ConversationParticipants { get; set; } public DbSet<Message> Messages { get; set; } public DbSet<Report> Reports { get; set; } public DbSet<Comment> Comments { get; set; } public DbSet<Notification> Notifications { get; set; } protected override void OnModelCreating(ModelBuilder modelBuilder) { base.OnModelCreating(modelBuilder); // Конфигурация сложных первичных ключей modelBuilder.Entity<ConversationParticipant>() .HasKey(cp => new { cp.ConversationId, cp.UserId }); // Дополнительные конфигурации при необходимости } } }4. Реализация репозиториев
В Domain Layer определите интерфейсы репозиториев для каждой сущности, если требуется абстракция доступа к данным:
using System.Collections.Generic; using System.Threading.Tasks; using YourProject.Domain.Models; namespace YourProject.Domain.Interfaces { public interface IUserRepository { Task<User> GetByIdAsync(int userId); Task<IEnumerable<User>> GetAllAsync(); Task AddAsync(User user); void Update(User user); void Delete(User user); // Другие методы по необходимости } // Аналогичные интерфейсы для других сущностей }В Infrastructure Layer реализуйте эти интерфейсы, используя
ApplicationDbContext:using System.Collections.Generic; using System.Threading.Tasks; using Microsoft.EntityFrameworkCore; using YourProject.Domain.Interfaces; using YourProject.Domain.Models; using YourProject.Infrastructure.Data; namespace YourProject.Infrastructure.Repositories { public class UserRepository : IUserRepository { private readonly ApplicationDbContext _context; public UserRepository(ApplicationDbContext context) { _context = context; } public async Task<User> GetByIdAsync(int userId) { return await _context.Users .Include(u => u.Cars) .FirstOrDefaultAsync(u => u.UserId == userId); } public async Task<IEnumerable<User>> GetAllAsync() { return await _context.Users .Include(u => u.Cars) .ToListAsync(); } public async Task AddAsync(User user) { await _context.Users.AddAsync(user); } public void Update(User user) { _context.Users.Update(user); } public void Delete(User user) { _context.Users.Remove(user); } // Другие методы по необходимости } // Аналогичные репозитории для других сущностей }5. Регистрация зависимостей
В Startup.cs или
Program.cs(в зависимости от версии ASP.NET Core) зарегистрируйте контекст и репозитории:using Microsoft.EntityFrameworkCore; using YourProject.Infrastructure.Data; using YourProject.Domain.Interfaces; using YourProject.Infrastructure.Repositories; // В методе ConfigureServices services.AddDbContext<ApplicationDbContext>(options => options.UseNpgsql(Configuration.GetConnectionString("DefaultConnection"))); services.AddScoped<IUserRepository, UserRepository>(); // Регистрация других репозиториев6. Создание контроллеров
В Presentation Layer (ASP.NET Web API) создайте контроллеры, которые будут взаимодействовать с Application Layer или напрямую с репозиториями через сервисы.
Пример контроллера для пользователей:
using Microsoft.AspNetCore.Mvc; using System.Threading.Tasks; using YourProject.Domain.Interfaces; using YourProject.Domain.Models; namespace YourProject.API.Controllers { [ApiController] [Route("api/[controller]")] public class UsersController : ControllerBase { private readonly IUserRepository _userRepository; public UsersController(IUserRepository userRepository) { _userRepository = userRepository; } [HttpGet("{id}")] public async Task<ActionResult<User>> GetUser(int id) { var user = await _userRepository.GetByIdAsync(id); if (user == null) return NotFound(); return Ok(user); } [HttpPost] public async Task<ActionResult> CreateUser([FromBody] User user) { await _userRepository.AddAsync(user); // Предполагается, что сохранение контекста происходит через Unit of Work или в другом месте return CreatedAtAction(nameof(GetUser), new { id = user.UserId }, user); } // Другие действия: Update, Delete и т.д. } }7. Дополнительные рекомендации
-
Data Annotations и Fluent API: Используйте Data Annotations или Fluent API для настройки моделей, например, ограничений длины строк, уникальности и т.д.
-
Миграции: Используйте миграции EF Core для управления схемой базы данных.
dotnet ef migrations add InitialCreate dotnet ef database update -
Сервисы и бизнес-логика: Разместите бизнес-логику в сервисных классах в Application Layer, чтобы контроллеры оставались тонкими и отвечали только за обработку HTTP-запросов.
-
DTO и AutoMapper: Используйте DTO (Data Transfer Objects) для передачи данных между слоями и AutoMapper для маппинга между сущностями и DTO.
-
Unit of Work: Рассмотрите возможность внедрения паттерна Unit of Work для управления транзакциями.
Заключение
Итак, ваши классы моделей должны находиться в папке
Domain/Modelsв Domain Layer. Они должны точно отражать структуру таблиц базы данных и включать навигационные свойства для связей. Далее, реализуйте репозитории в Infrastructure Layer, зарегистрируйте зависимости и создайте контроллеры в Presentation Layer для взаимодействия с клиентами через Web API.Следуя принципам Clean Architecture, вы обеспечите высокую степень модульности, тестируемости и поддерживаемости вашего приложения.
- Domain: Содержит модели, интерфейсы и бизнес-логику.