архитектура приложения с fastapi на входе, и контроллерами за ним
- User
архитектура приложения с fastapi на входе, и контроллерами за ним
- Assistant
Архитектура приложения с FastAPI может быть построена следующим образом:
-
Модель данных - описание структуры данных, используемых в приложении. Модель может быть описана с помощью Pydantic.
-
База данных - хранение данных, используемых в приложении. Для работы с базой данных можно использовать ORM, такой как SQLAlchemy.
-
Контроллеры - функции, которые обрабатывают HTTP-запросы от клиента и взаимодействуют с базой данных. Контроллеры могут быть организованы в модули, каждый из которых отвечает за определенный функционал.
-
API - реализация HTTP-методов для взаимодействия с клиентом. API определяется с помощью FastAPI, который автоматически генерирует документацию и выполняет валидацию входных данных.
Пример организации контроллеров:
from fastapi import APIRouter from fastapi.exceptions import HTTPException from sqlalchemy.orm import Session from . import models, schemas, crud from .database import get_db router = APIRouter() @router.post("/items") def create_item(item: schemas.ItemCreate, db: Session = Depends(get_db)): return crud.create_item(db=db, item=item) @router.get("/items/{item_id}") def read_item(item_id: int, db: Session = Depends(get_db)): db_item = crud.get_item(db=db, item_id=item_id) if db_item is None: raise HTTPException(status_code=404, detail="Item not found") return db_item @router.get("/items") def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): items = crud.get_items(db, skip=skip, limit=limit) return itemsВ данном примере контроллеры описывают операции создания элемента, чтения элемента и чтения списка элементов. В каждом контроллере определена зависимость от базы данных и используется функция для взаимодействия с базой данных. В идеале, каждый контроллер должен иметь одну четко определенную задачу.
-
- User
Добавь контроллер, который вызывает метод апи через http
- Assistant
Пример контроллера для вызова метода API через HTTP может выглядеть следующим образом:
import requests from fastapi import APIRouter router = APIRouter() @router.get("/call_api") def call_api(): response = requests.get("https://jsonplaceholder.typicode.com/todos/1") if response.status_code != 200: return {"status": "error", "message": "Failed to call API"} api_data = response.json() return {"status": "success", "data": api_data}В данном примере контроллер содержит функцию
call_api, которая отправляет GET-запрос на указанный URL и получает данные в формате JSON. Если получен ответ от сервера с кодом 200, то функция возвращает словарь, содержащий статус запроса и данные. Если же запрос не удался, то возвращается соответствующее сообщение об ошибке.Обратите внимание, что в данном примере используется библиотека
requestsдля отправки HTTP-запросов. Эту библиотеку нужно установить отдельно, например, с помощью командыpip install requests. - User
Добавь контроллер, который отправляет событие в rabbitmq
- Assistant
Пример контроллера для отправки события в RabbitMQ может выглядеть следующим образом:
import pika from fastapi import APIRouter router = APIRouter() @router.post("/send_event") def send_event(event_data: dict): # Установка соединения с RabbitMQ connection = pika.BlockingConnection(pika.ConnectionParameters('localhost')) channel = connection.channel() # Определение очереди, в которую будет отправлено событие channel.queue_declare(queue='events') # Преобразование данных события в строку в формате JSON event_data_str = json.dumps(event_data) # Отправка сообщения в очередь channel.basic_publish( exchange='', routing_key='events', body=event_data_str ) # Закрытие соединения с RabbitMQ connection.close() # Возвращение сообщения об успешном отправлении return {"status": "success", "message": "Event sent to RabbitMQ"}В данном примере контроллер содержит функцию
send_event, которая получает на вход данные события в формате словаря. Сначала функция устанавливает соединение с RabbitMQ, определяет очередь, в которую будет отправлено событие, преобразует данные события в строку в формате JSON и отправляет сообщение в очередь. Затем функция закрывает соединение и возвращает сообщение об успешном отправлении события.Обратите внимание, что для работы с RabbitMQ в данном примере используется библиотека
pika. Эту библиотеку нужно установить отдельно, например, с помощью командыpip install pika. Также нужно убедиться, что RabbitMQ запущен и работает на локальном компьютере. - User
Объедени все методы в один вывод
- Assistant
Конечный код может выглядеть примерно так:
import json import pika import requests from fastapi import FastAPI, APIRouter, Depends, HTTPException from sqlalchemy.orm import Session from . import models, schemas, crud from .database import get_db app = FastAPI() router = APIRouter() @router.post("/items") def create_item(item: schemas.ItemCreate, db: Session = Depends(get_db)): return crud.create_item(db=db, item=item) @router.get("/items/{item_id}") def read_item(item_id: int, db: Session = Depends(get_db)): db_item = crud.get_item(db=db, item_id=item_id) if db_item is None: raise HTTPException(status_code=404, detail="Item not found") return db_item @router.get("/items") def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)): items = crud.get_items(db, skip=skip, limit=limit) return items @router.get("/call_api") def call_api(): response = requests.get("https://jsonplaceholder.typicode.com/todos/1") if response.status_code != 200: return {"status": "error", "message": "Failed to call API"} api_data = response.json() return {"status": "success", "data": api_data} @router.post("/send_event") def send_event(event_data: dict): connection = pika.BlockingConnection(pika.ConnectionParameters('localhost')) channel = connection.channel() channel.queue_declare(queue='events') event_data_str = json.dumps(event_data) channel.basic_publish( exchange='', routing_key='events', body=event_data_str ) connection.close() return {"status": "success", "message": "Event sent to RabbitMQ"} app.include_router(router)В данном коде присутствуют все представленные выше контроллеры. Методы
create_item,read_itemиread_itemsпредоставляют доступ к базе данных и позволяют создавать, читать и управлять элементами списка. Методcall_apiотправляет GET-запрос на указанный URL и возвращает полученные данные. Методsend_eventотправляет указанные данные события в очередь RabbitMQ.Если необходимо использовать какую-то определенную реализацию базы данных, замените функции
get_dbиSessionв соответствующих местах на свою собственную реализацию. Также убедитесь, что библиотекиrequestsиpikaустановлены и находятся в системном пути. - User
Примени dry и solid к этим этому коду
- Assistant
Принцип DRY (Don't Repeat Yourself) нарушается в данном примере, так как код для работы с базой данных дублируется в каждом из контроллеров. Вместо этого следует вынести функционал работы с базой данных в отдельный модуль или вспомогательный класс, чтобы избежать дублирования кода.
Принцип SOLID нарушается в данном примере в том случае, если мы рассматриваем каждый контроллер как отдельную сущность и не уделяем внимание их взаимодействию. Если мы предполагаем дальнейшее развитие приложения, мы должны убедиться, что каждый контроллер выполняет только одну задачу и что он не зависит от других контроллеров. Кроме того, нужно обеспечить возможность легкого расширения функционала контроллеров без изменения существующего кода.
Чтобы следовать принципам DRY и SOLID, можно создать отдельный модуль, в котором определить классы для работы с базой данных и для обработки запросов HTTP. Классы для работы с базой данных могут быть реализованы с помощью паттерна Repository или Data Access Object (DAO), который позволяет абстрагироваться от конкретной реализации СУБД. Классы для обработки запросов могут быть реализованы с помощью паттерна Facade, который обеспечивает удобный интерфейс для взаимодействия с другими компонентами системы.
Например, код, удовлетворяющий принципам DRY и SOLID, может выглядеть следующим образом:
from typing import List from sqlalchemy.orm import Session from . import models, schemas from .database import Base, engine # Определение сессии базы данных SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) Base = declarative_base() # Определение класса для работы с базой данных class ItemRepository: def __init__(self, db: Session = Depends(get_db)): self.db = db def create(self, item: schemas.ItemCreate): db_item = models.Item(**item.dict()) self.db.add(db_item) self.db.commit() self.db.refresh(db_item) return db_item def get_by_id(self, item_id: int): return self.db.query(models.Item).filter(models.Item.id == item_id).first() def get_all(self, skip: int = 0, limit: int = 100): return self.db.query(models.Item).offset(skip).limit(limit).all() # Определение класса для обработки HTTP-запросов class ItemController: def __init__(self, item_repository: ItemRepository): self.item_repository = item_repository def create_item(self, item: schemas.ItemCreate): return self.item_repository.create(item) def get_item(self, item_id: int): item = self.item_repository.get_by_id(item_id) if item is None: raise HTTPException(status_code=404, detail="Item not found") return item def get_items(self, skip: int = 0, limit: int = 100): return self.item_repository.get_all(skip=skip, limit=limit)В данном примере определены два класса:
ItemRepositoryиItemController. КлассItemRepositoryинкапсулирует логику работы с базой данных и предоставляет методы для создания, чтения и обновления элементов списка. КлассItemControllerпредоставляет удобный интерфейс для обработки запросов HTTP и использует методы, определенные в классеItemRepository. Контроллеры, отвечающие за запросы к сервисам внешних систем, также могут быть реализованы в виде отдельных классов или модулей, чтобы отделить их логику от логики работы с базой данных.В итоге, код становится более читаемым, модульным и легко расширяемым.