Aujourd'hui, l'API REST est devenue la norme pour le développement d'applications web, permettant de décomposer le développement en parties indépendantes. Pour l'interface utilisateur, divers frameworks populaires comme Angular, React, Vue, et d'autres sont actuellement utilisés. Les développeurs backend peuvent choisir parmi une grande variété de langages et de frameworks. Aujourd'hui, je voudrais parler d'un framework appelé . Nous l'utilisons activement pour nos projets internes. En utilisant nest et le package @nestjsx/crud Pourquoi NestJS
Récemment, de nombreux frameworks backend ont émergé dans la communauté JavaScript. Bien qu'en termes de fonctionnalités, ils offrent des possibilités similaires à celles de Nest, il y en a un qui se démarque clairement : son architecture. Les fonctionnalités suivantes de NestJS permettent de créer des applications industrielles et d'évoluer avec de grandes équipes :
l'utilisation de TypeScript comme principal langage de développement. Bien que NestJS prenne en charge JavaScript, certaines fonctionnalités peuvent ne pas fonctionner, en particulier lorsqu'il s'agit de packages tiers ;
- la présence d'un conteneur DI, ce qui permet de créer des composants faiblement couplés ;
- les fonctionnalités du framework lui-même sont divisées en composants indépendants et interchangeables. Par exemple, en arrière-plan, le framework peut utiliser soit
- express , et via typeorm , , ;
- Le framework lui-même est inspiré du framework frontend Angular et a beaucoup en commun avec lui sur le plan conceptuel.
Installation de NestJS et déploiement du projet
Nest contient le package
nest /cli, который позволяет быстро развернуть базовый каркас приложения. Установим глобально данный пакет:
Après l'installation, générons la structure de base de notre application nomméenest-res t. Cela se fait en utilisant la commandenest new nest-rest nouveau nid nest-rest.
nouveau nid nest-rest
dmitrii@dmitrii-HP-ZBook-17-G3:~\/projects $ nest new nest-rest
Nous allons créer votre application en quelques secondes..
CRÉER \/nest-rest\/.prettierrc (51 octets)
CRÉER \/nest-rest\/README.md (3370 octets)
CRÉER \/nest-rest\/nest-cli.json (84 octets)
CRÉER \/nest-rest\/nodemon-debug.json (163 octets)
CRÉER \/nest-rest\/nodemon.json (67 octets)
CRÉER \/nest-rest\/package.json (1805 octets)
CRÉER \/nest-rest\/tsconfig.build.json (97 octets)
CRÉER \/nest-rest\/tsconfig.json (325 octets)
CRÉER \/nest-rest\/tslint.json (426 octets)
CRÉER \/nest-rest\/src\/app.controller.spec.ts (617 octets)
CRÉER \/nest-rest\/src\/app.controller.ts (274 octets)
CRÉER \/nest-rest\/src\/app.module.ts (249 octets)
CRÉER \/nest-rest\/src\/app.service.ts (142 octets)
CRÉER \/nest-rest\/src\/main.ts (208 octets)
CRÉER \/nest-rest\/test\/app.e2e-spec.ts (561 octets)
CRÉER \/nest-rest\/test\/jest-e2e.json (183 octets)
? Quel gestionnaire de paquets souhaitez-vous utiliser ? yarn
Installation en cours...
Projet nest-rest créé avec succès
Commencez avec les commandes suivantes :
$ cd nest-rest
$ yarn run start
Merci d'avoir installé Nest
Merci de considérer faire un don à notre collectif ouvert
pour nous aider à maintenir ce paquet.
Faire un don : https:\/\/opencollective.com\/nestEn tant que gestionnaire de paquets, nous allons choisir yarn.
Actuellement, vous pouvez démarrer le serveur avec la commande Voilà, c'est tout. Maintenant l'application React est lancée, vous pouvez y accéder en ouvrant votre navigateur à l'adresse et en allant à l'adresse vous pourrez voir la page d'accueil. Cependant, ce n'est pas pour ça que nous sommes ici, continuons.
Configurons le travail avec la base de données
Pour cet article, j'ai choisi PostgreSQL en tant que SGBD. On ne discute pas des goûts, mais à mon avis, c'est le SGBD le plus mûr, possédant toutes les fonctionnalités nécessaires. Comme déjà mentionné, Nest propose une intégration avec divers paquets pour travailler avec des bases de données. Étant donné que j'ai choisi PostgreSQL, il est logique de choisir TypeORM en tant qu'ORM. Installons les paquets nécessaires pour l'intégration avec la base de données :
yarn add typeorm @nestjs\/typeorm pg
Par ordre d'importance, voici à quoi sert chaque paquet :
- typeorm — paquet contenant l'ORM lui-même ;
- @nestjs\/typeorm — paquet TypeORM pour NestJS. Ajoute des modules à importer dans les modules du projet ainsi qu'un ensemble de décorateurs-aides ;
- pg — pilote pour interagir avec PostgreSQL.
D'accord, les paquets sont installés, il est maintenant nécessaire de démarrer la base elle-même. Pour déployer la base, j'utiliserai un docker-compose.yml de la manière suivante :
docker-compose.yml
version: '3.1'
services:
db:
image: postgres:11.2
restart: always
environment:
POSTGRES_PASSWORD: example
volumes:
- ..\/db:\/var\/lib\/postgresql\/data
- .\/postgresql.conf:\/etc\/postgresql\/postgresql.conf
ports:
- 5432:5432
adminer:
image: adminer
restart: always
ports:
- 8080:8080Comme vous pouvez le voir, ce fichier configure le lancement de 2 conteneurs :
- db — c'est le conteneur contenant la base de données. Dans notre cas, nous utilisons PostgreSQL version 11.2;
- Adminer — gestionnaire de base de données. Il fournit une interface web pour visualiser et gérer la base de données.
Pour travailler avec des connexions TCP, j'ai ajouté un fichier de configuration de ce contenu.
postgresql.conf
# -----------------------------
# PostgreSQL configuration file
# -----------------------------
#
# This file consists of lines of the form:
#
# name = value
#
# (The "=" is optional.) Whitespace may be used. Comments are introduced with
# "#" anywhere on a line. The complete list of parameter names and allowed
# values can be found in the PostgreSQL documentation.
#
# The commented-out settings shown in this file represent the default values.
# Re-commenting a setting is NOT sufficient to revert it to the default value;
# you need to reload the server.
#
# This file is read on server startup and when the server receives a SIGHUP
# signal. If you edit the file on a running system, you have to SIGHUP the
# server for the changes to take effect, run "pg_ctl reload", or execute
# "SELECT pg_reload_conf()". Some parameters, which are marked below,
# require a server shutdown and restart to take effect.
#
# Any parameter can also be given as a command-line option to the server, e.g.,
# "postgres -c log_connections=on". Some parameters can be changed at run time
# with the "SET" SQL command.
#
# Memory units: kB = kilobytes Time units: ms = milliseconds
# MB = megabytes s = seconds
# GB = gigabytes min = minutes
# TB = terabytes h = hours
# d = days
#------------------------------------------------------------------------------
# FILE LOCATIONS
#------------------------------------------------------------------------------
# The default values of these variables are driven from the -D command-line
# option or PGDATA environment variable, represented here as ConfigDir.
#data_directory = 'ConfigDir' # use data in another directory
# (change requires restart)
#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file
# (change requires restart)
#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file
# (change requires restart)
# If external_pid_file is not explicitly set, no extra PID file is written.
#external_pid_file = '' # write an extra PID file
# (change requires restart)
#------------------------------------------------------------------------------
# CONNECTIONS AND AUTHENTICATION
#------------------------------------------------------------------------------
# - Connection Settings -
listen_addresses = '*'
#listen_addresses = 'localhost' # what IP address(es) to listen on;
# comma-separated list of addresses;
# defaults to 'localhost'; use '*' for all
# (change requires restart)
#port = 5432 # (change requires restart)
#max_connections = 100 # (change requires restart)
#superuser_reserved_connections = 3 # (change requires restart)
#unix_socket_directories = '/tmp' # comma-separated list of directories
# (change requires restart)
#unix_socket_group = '' # (change requires restart)
#unix_socket_permissions = 0777 # begin with 0 to use octal notation
# (change requires restart)
#bonjour = off # advertise server via Bonjour
# (change requires restart)
#bonjour_name = '' # defaults to the computer name
# (change requires restart)
# - TCP Keepalives -
# see "man 7 tcp" for details
#tcp_keepalives_idle = 0 # TCP_KEEPIDLE, in seconds;
# 0 selects the system default
#tcp_keepalives_interval = 0 # TCP_KEEPINTVL, in seconds;
# 0 selects the system default
#tcp_keepalives_count = 0 # TCP_KEEPCNT;
# 0 selects the system default
# - Authentication -
#authentication_timeout = 1min # 1s-600s
#password_encryption = md5 # md5 or scram-sha-256
#db_user_namespace = off
# GSSAPI using Kerberos
#krb_server_keyfile = ''
#krb_caseins_users = off
# - SSL -
#ssl = off
#ssl_ca_file = ''
#ssl_cert_file = 'server.crt'
#ssl_crl_file = ''
#ssl_key_file = 'server.key'
#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers
#ssl_prefer_server_ciphers = on
#ssl_ecdh_curve = 'prime256v1'
#ssl_min_protocol_version = 'TLSv1'
#ssl_max_protocol_version = ''
#ssl_dh_params_file = ''
#ssl_passphrase_command = ''
#ssl_passphrase_command_supports_reload = off
#------------------------------------------------------------------------------
# RESOURCE USAGE (except WAL)
#------------------------------------------------------------------------------
# - Memory -
#shared_buffers = 32MB # min 128kB
# (change requires restart)
#huge_pages = try # on, off, or try
# (change requires restart)
#temp_buffers = 8MB # min 800kB
#max_prepared_transactions = 0 # zero disables the feature
# (change requires restart)
# Caution: it is not advisable to set max_prepared_transactions nonzero unless
# you actively intend to use prepared transactions.
#work_mem = 4MB # min 64kB
#maintenance_work_mem = 64MB # min 1MB
#autovacuum_work_mem = -1 # min 1MB, or -1 to use maintenance_work_mem
#max_stack_depth = 2MB # min 100kB
#shared_memory_type = mmap # the default is the first option
# supported by the operating system:
# mmap
# sysv
# windows
# (change requires restart)
#dynamic_shared_memory_type = posix # the default is the first option
# supported by the operating system:
# posix
# sysv
# windows
# mmap
# (change requires restart)
# - Disk -
#temp_file_limit = -1 # limits per-process temp file space
# in kB, or -1 for no limit
# - Kernel Resources -
#max_files_per_process = 1000 # min 25
# (change requires restart)
# - Cost-Based Vacuum Delay -
#vacuum_cost_delay = 0 # 0-100 milliseconds (0 disables)
#vacuum_cost_page_hit = 1 # 0-10000 credits
#vacuum_cost_page_miss = 10 # 0-10000 credits
#vacuum_cost_page_dirty = 20 # 0-10000 credits
#vacuum_cost_limit = 200 # 1-10000 credits
# - Background Writer -
#bgwriter_delay = 200ms # 10-10000ms between rounds
#bgwriter_lru_maxpages = 100 # max buffers written/round, 0 disables
#bgwriter_lru_multiplier = 2.0 # 0-10.0 multiplier on buffers scanned/round
#bgwriter_flush_after = 0 # measured in pages, 0 disables
# - Asynchronous Behavior -
#effective_io_concurrency = 1 # 1-1000; 0 disables prefetching
#max_worker_processes = 8 # (change requires restart)
#max_parallel_maintenance_workers = 2 # taken from max_parallel_workers
#max_parallel_workers_per_gather = 2 # taken from max_parallel_workers
#parallel_leader_participation = on
#max_parallel_workers = 8 # maximum number of max_worker_processes that
# can be used in parallel operations
#old_snapshot_threshold = -1 # 1min-60d; -1 disables; 0 is immediate
# (change requires restart)
#backend_flush_after = 0 # measured in pages, 0 disables
#------------------------------------------------------------------------------
# WRITE-AHEAD LOG
#------------------------------------------------------------------------------
# - Settings -
#wal_level = replica # minimal, replica, or logical
# (change requires restart)
#fsync = on # flush data to disk for crash safety
# (turning this off can cause
# unrecoverable data corruption)
#synchronous_commit = on # synchronization level;
# off, local, remote_write, remote_apply, or on
#wal_sync_method = fsync # the default is the first option
# supported by the operating system:
# open_datasync
# fdatasync (default on Linux)
# fsync
# fsync_writethrough
# open_sync
#full_page_writes = on # recover from partial page writes
#wal_compression = off # enable compression of full-page writes
#wal_log_hints = off # also do full page writes of non-critical updates
# (change requires restart)
#wal_buffers = -1 # min 32kB, -1 sets based on shared_buffers
# (change requires restart)
#wal_writer_delay = 200ms # 1-10000 milliseconds
#wal_writer_flush_after = 1MB # measured in pages, 0 disables
#commit_delay = 0 # range 0-100000, in microseconds
#commit_siblings = 5 # range 1-1000
# - Checkpoints -
#checkpoint_timeout = 5min # range 30s-1d
#max_wal_size = 1GB
#min_wal_size = 80MB
#checkpoint_completion_target = 0.5 # checkpoint target duration, 0.0 - 1.0
#checkpoint_flush_after = 0 # measured in pages, 0 disables
#checkpoint_warning = 30s # 0 disables
# - Archiving -
#archive_mode = off # enables archiving; off, on, or always
# (change requires restart)
#archive_command = '' # command to use to archive a logfile segment
# placeholders: %p = path of file to archive
# %f = file name only
# e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f'
#archive_timeout = 0 # force a logfile segment switch after this
# number of seconds; 0 disables
# - Archive Recovery -
# These are only used in recovery mode.
#restore_command = '' # command to use to restore an archived logfile segment
# placeholders: %p = path of file to restore
# %f = file name only
# e.g. 'cp /mnt/server/archivedir/%f %p'
# (change requires restart)
#archive_cleanup_command = '' # command to execute at every restartpoint
#recovery_end_command = '' # command to execute at completion of recovery
# - Recovery Target -
# Set these only when performing a targeted recovery.
#recovery_target = '' # 'immediate' to end recovery as soon as a
# consistent state is reached
# (change requires restart)
#recovery_target_name = '' # the named restore point to which recovery will proceed
# (change requires restart)
#recovery_target_time = '' # the time stamp up to which recovery will proceed
# (change requires restart)
#recovery_target_xid = '' # the transaction ID up to which recovery will proceed
# (change requires restart)
#recovery_target_lsn = '' # the WAL LSN up to which recovery will proceed
# (change requires restart)
#recovery_target_inclusive = on # Specifies whether to stop:
# just after the specified recovery target (on)
# just before the recovery target (off)
# (change requires restart)
#recovery_target_timeline = 'latest' # 'current', 'latest', or timeline ID
# (change requires restart)
#recovery_target_action = 'pause' # 'pause', 'promote', 'shutdown'
# (change requires restart)
#------------------------------------------------------------------------------
# REPLICATION
#------------------------------------------------------------------------------
# - Sending Servers -
# Set these on the master and on any standby that will send replication data.
#max_wal_senders = 10 # max number of walsender processes
# (change requires restart)
#wal_keep_segments = 0 # in logfile segments; 0 disables
#wal_sender_timeout = 60s # in milliseconds; 0 disables
#max_replication_slots = 10 # max number of replication slots
# (change requires restart)
#track_commit_timestamp = off # collect timestamp of transaction commit
# (change requires restart)
# - Master Server -
# These settings are ignored on a standby server.
#synchronous_standby_names = '' # standby servers that provide sync rep
# method to choose sync standbys, number of sync standbys,
# and comma-separated list of application_name
# from standby(s); '*' = all
#vacuum_defer_cleanup_age = 0 # number of xacts by which cleanup is delayed
# - Standby Servers -
# These settings are ignored on a master server.
#primary_conninfo = '' # connection string to sending server
# (change requires restart)
#primary_slot_name = '' # replication slot on sending server
# (change requires restart)
#promote_trigger_file = '' # file name whose presence ends recovery
#hot_standby = on # "off" disallows queries during recovery
# (change requires restart)
#max_standby_archive_delay = 30s # max delay before canceling queries
# when reading WAL from archive;
# -1 allows indefinite delay
#max_standby_streaming_delay = 30s # max delay before canceling queries
# when reading streaming WAL;
# -1 allows indefinite delay
#wal_receiver_status_interval = 10s # send replies at least this often
# 0 disables
#hot_standby_feedback = off # send info from standby to prevent
# query conflicts
#wal_receiver_timeout = 60s # time that receiver waits for
# communication from master
# in milliseconds; 0 disables
#wal_retrieve_retry_interval = 5s # time to wait before retrying to
# retrieve WAL after a failed attempt
#recovery_min_apply_delay = 0 # minimum delay for applying changes during recovery
# - Subscribers -
# These settings are ignored on a publisher.
#max_logical_replication_workers = 4 # taken from max_worker_processes
# (change requires restart)
#max_sync_workers_per_subscription = 2 # taken from max_logical_replication_workers
#------------------------------------------------------------------------------
# QUERY TUNING
#------------------------------------------------------------------------------
# - Planner Method Configuration -
#enable_bitmapscan = on
#enable_hashagg = on
#enable_hashjoin = on
#enable_indexscan = on
#enable_indexonlyscan = on
#enable_material = on
#enable_mergejoin = on
#enable_nestloop = on
#enable_parallel_append = on
#enable_seqscan = on
#enable_sort = on
#enable_tidscan = on
#enable_partitionwise_join = off
#enable_partitionwise_aggregate = off
#enable_parallel_hash = on
#enable_partition_pruning = on
# - Planner Cost Constants -
#seq_page_cost = 1.0 # measured on an arbitrary scale
#random_page_cost = 4.0 # same scale as above
#cpu_tuple_cost = 0.01 # same scale as above
#cpu_index_tuple_cost = 0.005 # same scale as above
#cpu_operator_cost = 0.0025 # same scale as above
#parallel_tuple_cost = 0.1 # same scale as above
#parallel_setup_cost = 1000.0 # same scale as above
#jit_above_cost = 100000 # perform JIT compilation if available
# and query more expensive than this;
# -1 disables
#jit_inline_above_cost = 500000 # inline small functions if query is
# more expensive than this; -1 disables
#jit_optimize_above_cost = 500000 # use expensive JIT optimizations if
# query is more expensive than this;
# -1 disables
#min_parallel_table_scan_size = 8MB
#min_parallel_index_scan_size = 512kB
#effective_cache_size = 4GB
# - Genetic Query Optimizer -
#geqo = on
#geqo_threshold = 12
#geqo_effort = 5 # range 1-10
#geqo_pool_size = 0 # selects default based on effort
#geqo_generations = 0 # selects default based on effort
#geqo_selection_bias = 2.0 # range 1.5-2.0
#geqo_seed = 0.0 # range 0.0-1.0
# - Other Planner Options -
#default_statistics_target = 100 # range 1-10000
#constraint_exclusion = partition # on, off, or partition
#cursor_tuple_fraction = 0.1 # range 0.0-1.0
#from_collapse_limit = 8
#join_collapse_limit = 8 # 1 disables collapsing of explicit
# JOIN clauses
#force_parallel_mode = off
#jit = on # allow JIT compilation
#plan_cache_mode = auto # auto, force_generic_plan or
# force_custom_plan
#------------------------------------------------------------------------------
# REPORTING AND LOGGING
#------------------------------------------------------------------------------
# - Where to Log -
#log_destination = 'stderr' # Valid values are combinations of
# stderr, csvlog, syslog, and eventlog,
# depending on platform. csvlog
# requires logging_collector to be on.
# This is used when logging to stderr:
#logging_collector = off # Enable capturing of stderr and csvlog
# into log files. Required to be on for
# csvlogs.
# (change requires restart)
# These are only used if logging_collector is on:
#log_directory = 'log' # directory where log files are written,
# can be absolute or relative to PGDATA
#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log' # log file name pattern,
# can include strftime() escapes
#log_file_mode = 0600 # creation mode for log files,
# begin with 0 to use octal notation
#log_truncate_on_rotation = off # If on, an existing log file with the
# same name as the new log file will be
# truncated rather than appended to.
# But such truncation only occurs on
# time-driven rotation, not on restarts
# or size-driven rotation. Default is
# off, meaning append to existing files
# in all cases.
#log_rotation_age = 1d # Automatic rotation of logfiles will
# happen after that time. 0 disables.
#log_rotation_size = 10MB # Automatic rotation of logfiles will
# happen after that much log output.
# 0 disables.
# These are relevant when logging to syslog:
#syslog_facility = 'LOCAL0'
#syslog_ident = 'postgres'
#syslog_sequence_numbers = on
#syslog_split_messages = on
# This is only relevant when logging to eventlog (win32):
# (change requires restart)
#event_source = 'PostgreSQL'
# - When to Log -
#log_min_messages = warning # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic
#log_min_error_statement = error # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# info
# notice
# warning
# error
# log
# fatal
# panic (effectively off)
#log_min_duration_statement = -1 # logs statements and their durations
# according to log_statement_sample_rate. -1 is disabled,
# 0 logs all statement, > 0 logs only statements running at
# least this number of milliseconds.
#log_statement_sample_rate = 1 # Fraction of logged statements over
# log_min_duration_statement. 1.0 logs all statements,
# 0 never logs.
# - What to Log -
#debug_print_parse = off
#debug_print_rewritten = off
#debug_print_plan = off
#debug_pretty_print = on
#log_checkpoints = off
#log_connections = off
#log_disconnections = off
#log_duration = off
#log_error_verbosity = default # terse, default, or verbose messages
#log_hostname = off
#log_line_prefix = '%m [%p] ' # special values:
# %a = application name
# %u = user name
# %d = database name
# %r = remote host and port
# %h = remote host
# %p = process ID
# %t = timestamp without milliseconds
# %m = timestamp with milliseconds
# %n = timestamp with milliseconds (as a Unix epoch)
# %i = command tag
# %e = SQL state
# %c = session ID
# %l = session line number
# %s = session start timestamp
# %v = virtual transaction ID
# %x = transaction ID (0 if none)
# %q = stop here in non-session
# processes
# %% = '%'
# e.g. '<%u%%%d> '
#log_lock_waits = off # log lock waits >= deadlock_timeout
#log_statement = 'none' # none, ddl, mod, all
#log_replication_commands = off
#log_temp_files = -1 # log temporary files equal or larger
# than the specified size in kilobytes;
# -1 disables, 0 logs all temp files
#log_timezone = 'GMT'
#------------------------------------------------------------------------------
# PROCESS TITLE
#------------------------------------------------------------------------------
#cluster_name = '' # added to process titles if nonempty
# (change requires restart)
#update_process_title = on
#------------------------------------------------------------------------------
# STATISTICS
#------------------------------------------------------------------------------
# - Query and Index Statistics Collector -
#track_activities = on
#track_counts = on
#track_io_timing = off
#track_functions = none # none, pl, all
#track_activity_query_size = 1024 # (change requires restart)
#stats_temp_directory = 'pg_stat_tmp'
# - Monitoring -
#log_parser_stats = off
#log_planner_stats = off
#log_executor_stats = off
#log_statement_stats = off
#------------------------------------------------------------------------------
# AUTOVACUUM
#------------------------------------------------------------------------------
#autovacuum = on # Enable autovacuum subprocess? 'on'
# requires track_counts to also be on.
#log_autovacuum_min_duration = -1 # -1 disables, 0 logs all actions and
# their durations, > 0 logs only
# actions running at least this number
# of milliseconds.
#autovacuum_max_workers = 3 # max number of autovacuum subprocesses
# (change requires restart)
#autovacuum_naptime = 1min # time between autovacuum runs
#autovacuum_vacuum_threshold = 50 # min number of row updates before
# vacuum
#autovacuum_analyze_threshold = 50 # min number of row updates before
# analyze
#autovacuum_vacuum_scale_factor = 0.2 # fraction of table size before vacuum
#autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze
#autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum
# (change requires restart)
#autovacuum_multixact_freeze_max_age = 400000000 # maximum multixact age
# before forced vacuum
# (change requires restart)
#autovacuum_vacuum_cost_delay = 2ms # default vacuum cost delay for
# autovacuum, in milliseconds;
# -1 means use vacuum_cost_delay
#autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for
# autovacuum, -1 means use
# vacuum_cost_limit
#------------------------------------------------------------------------------
# CLIENT CONNECTION DEFAULTS
#------------------------------------------------------------------------------
# - Statement Behavior -
#client_min_messages = notice # values in order of decreasing detail:
# debug5
# debug4
# debug3
# debug2
# debug1
# log
# notice
# warning
# error
#search_path = '"$user", public' # schema names
#row_security = on
#default_tablespace = '' # a tablespace name, '' uses the default
#temp_tablespaces = '' # a list of tablespace names, '' uses
# only default tablespace
#check_function_bodies = on
#default_transaction_isolation = 'read committed'
#default_transaction_read_only = off
#default_transaction_deferrable = off
#session_replication_role = 'origin'
#statement_timeout = 0 # in milliseconds, 0 is disabled
#lock_timeout = 0 # in milliseconds, 0 is disabled
#idle_in_transaction_session_timeout = 0 # in milliseconds, 0 is disabled
#vacuum_freeze_min_age = 50000000
#vacuum_freeze_table_age = 150000000
#vacuum_multixact_freeze_min_age = 5000000
#vacuum_multixact_freeze_table_age = 150000000
#vacuum_cleanup_index_scale_factor = 0.1 # fraction of total number of tuples
# before index cleanup, 0 always performs
# index cleanup
#bytea_output = 'hex' # hex, escape
#xmlbinary = 'base64'
#xmloption = 'content'
#gin_fuzzy_search_limit = 0
#gin_pending_list_limit = 4MB
# - Locale and Formatting -
#datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
#timezone = 'GMT'
#timezone_abbreviations = 'Default' # Select the set of available time zone
# abbreviations. Currently, there are
# Default
# Australia (historical usage)
# India
# You can create your own file in
# share/timezonesets/.
#extra_float_digits = 1 # min -15, max 3; any value >0 actually
# selects precise output mode
#client_encoding = sql_ascii # actually, defaults to database
# encoding
# These settings are initialized by initdb, but they can be changed.
#lc_messages = 'C' # locale for system error message
# strings
#lc_monetary = 'C' # locale for monetary formatting
#lc_numeric = 'C' # locale for number formatting
#lc_time = 'C' # locale for time formatting
# default configuration for text search
#default_text_search_config = 'pg_catalog.simple'
# - Shared Library Preloading -
#shared_preload_libraries = '' # (change requires restart)
#local_preload_libraries = ''
#session_preload_libraries = ''
#jit_provider = 'llvmjit' # JIT library to use
# - Other Defaults -
#dynamic_library_path = '$libdir'
#------------------------------------------------------------------------------
# LOCK MANAGEMENT
#------------------------------------------------------------------------------
#deadlock_timeout = 1s
#max_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_transaction = 64 # min 10
# (change requires restart)
#max_pred_locks_per_relation = -2 # negative values mean
# (max_pred_locks_per_transaction
# / -max_pred_locks_per_relation) - 1
#max_pred_locks_per_page = 2 # min 0
#------------------------------------------------------------------------------
# VERSION AND PLATFORM COMPATIBILITY
#------------------------------------------------------------------------------
# - Previous PostgreSQL Versions -
#array_nulls = on
#backslash_quote = safe_encoding # on, off, or safe_encoding
#escape_string_warning = on
#lo_compat_privileges = off
#operator_precedence_warning = off
#quote_all_identifiers = off
#standard_conforming_strings = on
#synchronize_seqscans = on
# - Other Platforms and Clients -
#transform_null_equals = off
#------------------------------------------------------------------------------
# ERROR HANDLING
#------------------------------------------------------------------------------
#exit_on_error = off # terminate session on any error?
#restart_after_crash = on # reinitialize after backend crash?
#data_sync_retry = off # retry or panic on failure to fsync
# data?
# (change requires restart)
#------------------------------------------------------------------------------
# CONFIG FILE INCLUDES
#------------------------------------------------------------------------------
# These options allow settings to be loaded from files other than the
# default postgresql.conf.
#include_dir = 'conf.d' # include files ending in '.conf' from
# directory 'conf.d'
#include_if_exists = 'exists.conf' # include file only if it exists
#include = 'special.conf' # include file
#------------------------------------------------------------------------------
# CUSTOMIZED OPTIONS
#------------------------------------------------------------------------------
# Add settings for extensions hereC'est tout, vous pouvez démarrer les conteneurs avec la commande docker-compose up -d. Ou dans un terminal séparé avec la commande docker-compose up.
Ainsi, les paquets sont installés, la base de données est lancée, il ne reste plus qu'à les interconnecter. Pour cela, vous devez ajouter un fichier ormconfig.js à la racine du projet avec le contenu suivant :
ormconfig.js
const process = require('process');
const username = process.env.POSTGRES_USER || "postgres";
const password = process.env.POSTGRES_PASSWORD || "example";
module.exports = {
"type": "postgres",
"host": "localhost",
"port": 5432,
username,
password,
"database": "postgres",
"synchronize": true,
"dropSchema": false,
"logging": true,
"entities": [__dirname + "\/src\/**\/*.entity.ts", __dirname + "\/dist\/**\/*.entity.js"],
"migrations": ["migrations\/**\/*.ts"],
"subscribers": ["subscriber\/**\/*.ts", "dist\/subscriber\/**\/*.js"],
"cli": {
"entitiesDir": "src",
"migrationsDir": "migrations",
"subscribersDir": "subscriber"
}
}
Cette configuration sera utilisée pour le cli de typeorm.
Examinons cette configuration plus en détail. Aux lignes 3 et 4, nous récupérons le nom d'utilisateur et le mot de passe à partir des variables d'environnement. C'est pratique lorsque vous avez plusieurs environnements (dev, stage, prod, etc.). Par défaut, le nom d'utilisateur est postgres, le mot de passe est example. Le reste de la configuration est trivial, nous nous concentrerons donc uniquement sur les paramètres les plus intéressants :
- synchronize — indique si le schéma de la base de données doit être créé automatiquement à chaque démarrage de l'application. Faites attention avec cette option et ne l'utilisez pas en production, sinon vous perdrez des données. Cette option est pratique lors du développement et du débogage de l'application. Comme alternative, vous pouvez utiliser la commande
schema:syncdans le CLI de TypeORM. - dropSchema — réinitialiser le schéma chaque fois qu'une connexion est établie. Tout comme l'option précédente, celle-ci doit également être utilisée uniquement pendant le développement et le débogage de l'application.
- entities — spécifie les chemins pour chercher la description des modèles. Notez qu'il supporte la recherche par masque.
- cli.entitiesDir — répertoire où les modèles créés à partir de CLI TypeORM doivent être stockés par défaut.
Pour que nous puissions utiliser toutes les fonctionnalités de TypeORM dans notre application Nest, il est nécessaire d'importer le module TypeOrmModule dans AppModule. C'est-à-dire que votre AppModule devrait ressembler à ceci :
app.module.ts
import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import * as process from "process";
const username = process.env.POSTGRES_USER || 'postgres';
const password = process.env.POSTGRES_PASSWORD || 'example';
@Module({
imports: [
TypeOrmModule.forRoot({
type: 'postgres',
host: 'localhost',
port: 5432,
username,
password,
database: 'postgres',
entities: [__dirname + '/**/*.entity{.ts,.js}'],
synchronize: true,
}),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}Comme vous avez pu le remarquer, dans la méthode forRoot la même configuration pour travailler avec la base de données est transmise, comme dans le fichier ormconfig.ts
Il reste une touche finale : ajouter quelques tâches pour travailler avec TypeORM dans package.json. Le fait est que le CLI est écrit en javascript et s'exécute dans l'environnement nodejs. Cependant, tous nos modèles et migrations seront écrits en typescript. Il est donc nécessaire de transpirer nos migrations et modèles avant d'utiliser le CLI. Pour cela, nous aurons besoin du package ts-node :
yarn add -D ts-node
Après cela, ajoutons les commandes nécessaires dans package.json :
"typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js",
"migration:generate": "yarn run typeorm migration:generate -n",
"migration:create": "yarn run typeorm migration:create -n",
"migration:run": "yarn run typeorm migration:run"La première commande, typeorm, ajoute un wrapper sous forme de ts-node pour exécuter le cli TypeORM. Les autres commandes sont des raccourcis pratiques que vous, en tant que développeur, utiliserez presque tous les jours :
migration:generate — création de migrations sur la base des changements apportés à vos modèles.
migration:create — création d'une migration vide.
migration:run — exécution des migrations.
Eh bien, maintenant c'est sûr, nous avons ajouté les packages nécessaires, configuré l'application pour travailler avec la base à la fois via le cli et depuis l'application, et lancé la SGBD. Il est temps d'ajouter la logique à notre application.
Installation des packages pour créer un CRUD
En utilisant uniquement Nest, il est possible de créer une API permettant de créer, lire, mettre à jour et supprimer une entité. Une telle solution sera très flexible, mais pour certains cas, elle est peut-être excessive. Par exemple, si vous devez rapidement créer un prototype, il est souvent possible de sacrifier la flexibilité au profit de la rapidité de développement. De nombreux frameworks offrent une fonctionnalité de génération de CRUD à partir de la description d'un modèle de données d'une entité donnée. Et Nest ne fait pas exception ! Cette fonctionnalité est fournie par le package . Ses capacités sont assez intéressantes :
- installation et configuration faciles ;
- indépendance par rapport à la SGBD ;
- un langage de requêtes puissant avec des capacités de filtrage, de pagination, de tri, de chargement des relations et des entités imbriquées, la mise en cache, etc.;
- un paquet pour générer des requêtes côté front-end;
- une redéfinition facile des méthodes du contrôleur;
- une petite configuration;
- prise en charge de la documentation swagger.
La fonctionnalité est divisée en plusieurs paquets :
- — paquet de base, qui fournit un décorateur () pour générer des routes, configurer et valider;
- — paquet fournissant un générateur/parseur de requêtes pour une utilisation côté front-end;
- — paquet pour l'intégration avec TypeORM, fournissant le service de base TypeOrmCrudService avec des méthodes CRUD pour travailler avec des entités dans une base de données.
Dans ce guide, nous aurons besoin des paquets jsx/crud et jsx/crud-typeorm. Pour commencer, nous allons les installer
yarn add @nestjsx/crud class-transformer class-validatorPackages et dans cette application sont nécessaires pour la description déclarative des règles de transformation des instances de modèles et la validation des requêtes entrantes respectivement. Ces paquets sont de la même auteur, donc les interfaces sont similaires.
Implémentation directe du CRUD
À titre d'exemple, nous prendrons une liste d'utilisateurs. Les utilisateurs auront les champs suivants : id, username, displayName, email. id — champ à auto-incrémentation, email et username — champs uniques. C'est simple ! Il ne reste plus qu'à concrétiser notre idée sous la forme d'une application Nest.
Tout d'abord, il est nécessaire de créer un module users, qui sera responsable de la gestion des utilisateurs. Utilisons le CLI de NestJS, et dans le répertoire racine de notre projet, exécutons la commande nest g module users.
nest g module users
dmitrii@dmitrii-HP-ZBook-17-G3:~/projects/nest-rest git:(master*)$ nest g module users
CREATE /src/users/users.module.ts (82 bytes)
UPDATE /src/app.module.ts (312 bytes)Dans ce module, nous ajouterons un dossier entités, où nous placerons les modèles de ce module. En particulier, nous ajouterons ici le fichier user.entity.ts avec la description du modèle des utilisateurs :
user.entity.ts
import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';
@Entity()
export class User {
@PrimaryGeneratedColumn()
id: string;
@Column({unique: true})
email: string;
@Column({unique: true})
username: string;
@Column({nullable: true})
displayName: string;
}Pour que ce modèle soit « vu » par notre application, il est nécessaire d'importer dans le module UsersModule le fichier TypeOrmModule avec le contenu suivant :
users.module.ts
import { Module } from '@nestjs/common';
import { UsersController } from './controllers/users/users.controller';
import { UsersService } from './services/users/users.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import { User } from './entities/user.entity';
@Module({
controllers: [UsersController],
providers: [UsersService],
imports: [
TypeOrmModule.forFeature([User])
]
})
export class UsersModule {}C'est-à-dire ici nous importons TypeOrmModule, où comme paramètre de la méthode forFeature nous indiquons la liste des modèles associés à ce module.
Il reste à créer l'entité correspondante dans la base de données. Pour cela, nous utilisons le mécanisme des migrations. Pour générer une migration basée sur les modifications apportées aux modèles, il faut exécuter la commande npm run migration:generate -- CreateUserTable:
Titre du spoiler
$ npm run migration:generate -- CreateUserTable
Migration /home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts a été générée avec succès.
Fait en 1.96s.Nous n'avons pas eu besoin d'écrire la migration manuellement, tout s'est passé de manière magique. N'est-ce pas un miracle ! Cependant, ce n'est pas tout. Jetons un œil au fichier de migration créé :
1563346135367-CreateUserTable.ts
import {MigrationInterface, QueryRunner} from "typeorm";
export class CreateUserTable1563346816726 implements MigrationInterface {
public async up(queryRunner: QueryRunner): Promise {
await queryRunner.query(`CREATE TABLE "user" ("id" SERIAL NOT NULL, "email" character varying NOT NULL, "username" character varying NOT NULL, "displayName" character varying, CONSTRAINT "UQ_e12875dfb3b1d92d7d7c5377e22" UNIQUE ("email"), CONSTRAINT "UQ_78a916df40e02a9deb1c4b75edb" UNIQUE ("username"), CONSTRAINT "PK_cace4a159ff9f2512dd42373760" PRIMARY KEY ("id"))`);
}
public async down(queryRunner: QueryRunner): Promise {
await queryRunner.query(`DROP TABLE "user"`);
}
}Comme on peut le constater, non seulement la méthode pour exécuter la migration a été automatiquement générée, mais aussi la méthode pour la rétrograder. Fantastique !
Il ne reste plus qu'à appliquer cette migration. Cela se fait avec la commande suivante :
npm run migration:run.Voilà, les modifications du schéma ont été appliquées à la base de données.
Ensuite, créons un service qui s'occupera de la gestion des utilisateurs et héritons-le de TypeOrmCrudService. Dans le paramètre du constructeur parent, il faut passer le dépôt de l'entité qui nous intéresse, dans notre cas User le dépôt.
users.service.ts
import { Injectable } from '@nestjs/common';
import { TypeOrmCrudService } from '@nestjsx/crud-typeorm';
import { User } from '../..//entities/user.entity';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
@Injectable()
export class UsersService extends TypeOrmCrudService{
constructor(@InjectRepository(User) usersRepository: Repository){
super(usersRepository);
}
}Ce service nous sera utile dans le contrôleur users. Pour créer le contrôleur, tapez dans la console nest g controller users/controllers/users
nest g controller users/controllers/users
dmitrii@dmitrii-HP-ZBook-17-G3:~/projects/nest-rest git:(master*)$ nest g controller users/controllers/users
CREATE /src/users/controllers/users/users.controller.spec.ts (486 bytes)
CREATE /src/users/controllers/users/users.controller.ts (99 bytes)
UPDATE /src/users/users.module.ts (188 bytes)Ouvrons ce contrôleur et modifions-le pour y ajouter un peu de magie jsx/crud. À la classe UsersController ajoutons un décorateur de ce type :
@Crud({
model: {
type: User
}
}) — est un décorateur qui ajoute les méthodes nécessaires au contrôleur pour travailler avec le modèle. Le type de modèle est indiqué dans le champ model.type de la configuration du décorateur.
La deuxième étape consiste à implémenter l'interface CrudController. Dans son ensemble, le code du contrôleur ressemble à ceci :
import { Controller } from '@nestjs/common';
import { Crud, CrudController } from '@nestjsx/crud';
import { User } from '../../entities/user.entity';
import { UsersService } from '../../services/users/users.service';
@Crud({
model: {
type: User
}
})
@Controller('users')
export class UsersController implements CrudController{
constructor(public service: UsersService){}
}Et c'est tout ! Le contrôleur prend maintenant en charge l'ensemble des opérations sur le modèle ! Vous n'y croyez pas ? Essayons notre application en action !
Création d'un scénario de requêtes dans TestMace
Pour tester notre service, nous allons utiliser un IDE pour travailler avec l'API . Pourquoi TestMace ? Par rapport à des produits similaires, il offre les avantages suivants :
- puissante gestion des variables. Actuellement, il existe plusieurs types de variables, chacune ayant un rôle spécifique : variables intégrées, variables dynamiques, variables d'environnement. Chaque variable appartient à un nœud avec un mécanisme d'héritage ;
- création facile de scénarios sans programmation. Cela sera abordé plus tard ;
- format lisible par l'homme, permettant de conserver le projet dans des systèmes de contrôle de version ;
- auto-complétion, coloration syntaxique, mise en valeur des valeurs des variables ;
- prise en charge de la description de l'API avec possibilité d'importation depuis Swagger.
Lançons notre serveur avec la commande Voilà, c'est tout. Maintenant l'application React est lancée, vous pouvez y accéder en ouvrant votre navigateur à l'adresse et essayons d'accéder à la liste des utilisateurs. D'après notre configuration du contrôleur, la liste des utilisateurs peut être obtenue à l'URL localhost:3000/users. Faisons une requête à cette URL.
Après le lancement de TestMace, vous pouvez voir cette interface :
En haut à gauche se trouve l'arborescence des projets avec le nœud racine . Essayons de créer la première requête pour obtenir la liste des utilisateurs. Pour cela, créons un nœud. Cela se fait dans le menu contextuel du nœud Projet Ajouter un nœud -> RequestStep.
Dans le champ URL, insérez localhost:3000/users et exécutez la requête. Nous obtiendrons un code 200 avec un tableau vide dans le corps de la réponse. Cela se comprend, nous n'avons encore ajouté personne.
Créons un scénario qui comprendra les étapes suivantes :
- création d'un utilisateur ;
- requête par id du nouvel utilisateur créé ;
- suppression par l'id de l'utilisateur créé à l'étape 1.
Alors, c'est parti. Pour plus de commodité, créons un nœud de type . C'est essentiellement un simple dossier dans lequel nous allons sauvegarder tout le scénario. Pour créer un nœud Dossier, il est nécessaire de sélectionner dans le menu contextuel du nœud Projet Ajouter un nœud -> Dossier. Appelons le nœud check-create. À l'intérieur du nœud check-create nous allons créer notre première requête pour créer un utilisateur. Appelons le nœud nouvellement créé create-user. À ce stade, la hiérarchie des nœuds ressemblera à ceci :
Passons à l'onglet du nœud ouvert. create-user Entrons les paramètres suivants pour la requête :
- Type de requête — POST
- URL — localhost:3000/users
- Body — JSON contenant la valeur
{"email": "user@user.com", "displayName": "Nouvel utilisateur", "username": "user"}
Exécutons cette requête. Notre application indique que l'enregistrement a été créé.
Eh bien, vérifions ce fait. Pour pouvoir manipuler l'id de l'utilisateur créé dans les étapes suivantes, ce paramètre doit être sauvegardé. Le mécanisme des est parfait pour cela. Voyons comment cela fonctionne dans notre exemple. Dans l'onglet analysé de la réponse, pour le nœud id, dans le menu contextuel, il faut choisir l'option Attribuer à la variable. Dans la fenêtre de dialogue, il faut définir les paramètres suivants :
- Nœud — dans quel ancêtre créer la variable dynamique. Choisissons check-create
- Nom de la variable — le nom de cette variable. Appelons-la
userId.
Voici à quoi ressemble le processus de création d'une variable dynamique :
Maintenant, à chaque exécution de cette requête, la valeur de la variable dynamique sera mise à jour. Étant donné que les variables dynamiques prennent en charge le mécanisme d'héritage hiérarchique, la variable userId sera accessible dans les descendants check-create d'un nœud à n'importe quel niveau d'imbrication.
Dans la prochaine requête, nous aurons besoin de cette variable. En effet, nous allons demander l'utilisateur nouvellement créé. En tant que descendant du nœud check-create nous allons créer la requête check-if exists avec le paramètre url égale à localhost:3000/users/${$dynamicVar.userId}. La construction du type ${variable_name} permet d'obtenir la valeur de la variable. Comme il s'agit d'une variable dynamique, pour l'obtenir, il faut se référer à l'objet $dynamicVar, c'est-à-dire que la référence complète à la variable dynamique userId sera la suivante ${$dynamicVar.userId}. Exécutons la requête et assurons-nous que les données sont récupérées correctement.
Il reste une dernière étape : faire une demande de suppression. Nous en avons besoin non seulement pour vérifier le bon fonctionnement de la suppression, mais aussi, pour ainsi dire, pour nettoyer derrière nous dans la base, car les champs email et username sont uniques. Donc, dans le nœud check-create, nous allons créer une demande delete-user avec les paramètres suivants
- Type de demande - DELETE
- URL -
localhost:3000/users/${$dynamicVar.userId}
Lançons. Attendez. Apprécions le résultat :)
Et maintenant, nous pouvons exécuter entièrement ce scénario à tout moment. Pour lancer le scénario, il est nécessaire de sélectionner dans le menu contextuel check-create le nœud l'élément Exécution.
Les nœuds dans le scénario s'exécuteront les uns après les autres
Vous pouvez sauvegarder ce scénario dans votre projet en réalisant Fichier -> Sauvegarder le projet.
Conclusion
Le format de cet article n'a tout simplement pas pu contenir toutes les fonctionnalités des outils utilisés. En ce qui concerne le principal acteur - le paquet jsx/crud - les sujets suivants sont restés inexplorés :
- validation et transformation personnalisées des modèles ;
- un puissant langage de requêtes et son utilisation facile sur le front ;
- redéfinition et ajout de nouvelles méthodes dans les contrôleurs crud ;
- support swagger ;
- gestion du cache.
Cependant, même ce qui est décrit dans l'article est suffisant pour comprendre qu'un tel framework d'entreprise comme NestJS dispose d'outils pour un prototypage rapide d'applications. Et une IDE aussi géniale que permet de maintenir le rythme établi.
Le code source de cet article, ainsi que le projet , est disponible dans le dépôt . Pour ouvrir le projet il suffit d'exécuter dans l'application Fichier -> Ouvrir le projet.
Source : habr.com
