Actualmente, a API REST converteuse nun estándar para o desenvolvemento de aplicacións web, o que permite que o desenvolvemento se divida en partes independentes. Actualmente utilízanse varios frameworks populares como Angular, React, Vue e outros para a IU. Os desenvolvedores de backend poden escoller entre unha gran variedade de linguaxes e marcos. Hoxe gustaríame falar dun marco como NestJS. Estamos dentro TestMace Utilizámolo activamente para proxectos internos. Usando niño e paquete @nestjsx/crud, crearemos unha aplicación CRUD sinxela.

Por que NestJS

Recentemente, apareceron moitos frameworks de backend na comunidade JavaScript. E se en termos de funcionalidade proporcionan capacidades similares a Nest, entón en definitiva gaña: esta é a arquitectura. As seguintes funcións de NestJS permítenche crear aplicacións industriais e escalar o desenvolvemento a grandes equipos:

• utilizando TypeScript como principal linguaxe de desenvolvemento. Aínda que NestJS admite JavaScript, algunhas funcionalidades poden non funcionar, especialmente se estamos a falar de paquetes de terceiros;
• a presenza dun recipiente DI, que permite crear compoñentes pouco acoplados;
• A funcionalidade do propio cadro divídese en compoñentes intercambiables independentes. Por exemplo, baixo o capó como marco pódese usar como expresadoE axilizar, para traballar coa base de datos, o niño fóra da caixa ofrece enlaces para tiporma, mangosta, secuela;
• NestJS é independente da plataforma e admite REST, GraphQL, Websockets, gRPC, etc.

O marco en si está inspirado no marco frontend de Angular e conceptualmente ten moito en común con el.

Instalación de NestJS e implantación do proxecto

Nest contén un paquete niño/cli, que lle permite implementar rapidamente un marco de aplicación básico. Imos instalar este paquete globalmente:

npm install --global @nest/cli

Despois da instalación, xeraremos o marco básico da nosa aplicación co nome niño-rest. Isto faise usando o comando nest new nest-rest.

niño novo niño-resto

dmitrii@dmitrii-HP-ZBook-17-G3:~/projects $ nest new nest-rest
  We will scaffold your app in a few seconds..

CREATE /nest-rest/.prettierrc (51 bytes)
CREATE /nest-rest/README.md (3370 bytes)
CREATE /nest-rest/nest-cli.json (84 bytes)
CREATE /nest-rest/nodemon-debug.json (163 bytes)
CREATE /nest-rest/nodemon.json (67 bytes)
CREATE /nest-rest/package.json (1805 bytes)
CREATE /nest-rest/tsconfig.build.json (97 bytes)
CREATE /nest-rest/tsconfig.json (325 bytes)
CREATE /nest-rest/tslint.json (426 bytes)
CREATE /nest-rest/src/app.controller.spec.ts (617 bytes)
CREATE /nest-rest/src/app.controller.ts (274 bytes)
CREATE /nest-rest/src/app.module.ts (249 bytes)
CREATE /nest-rest/src/app.service.ts (142 bytes)
CREATE /nest-rest/src/main.ts (208 bytes)
CREATE /nest-rest/test/app.e2e-spec.ts (561 bytes)
CREATE /nest-rest/test/jest-e2e.json (183 bytes)

? Which package manager would you ️ to use? yarn
 Installation in progress... 

  Successfully created project nest-rest
  Get started with the following commands:

$ cd nest-rest
$ yarn run start

                          Thanks for installing Nest 
                 Please consider donating to our open collective
                        to help us maintain this package.

                 Donate: https://opencollective.com/nest

Elixiremos o fío como o noso xestor de paquetes.
Neste punto pode iniciar o servidor co comando npm start e indo ao enderezo http://localhost:3000 podes ver a páxina principal. Non obstante, non por iso nos reunimos aquí e seguimos adiante.

Configurar o traballo coa base de datos

Escollín PostrgreSQL como DBMS para este artigo. Non hai disputa sobre gustos; na miña opinión, este é o DBMS máis maduro, con todas as capacidades necesarias. Como xa se mencionou, Nest ofrece integración con varios paquetes para traballar con bases de datos. Porque Dado que a miña elección recaeu en PostgreSQL, sería lóxico escoller TypeORM como ORM. Imos instalar os paquetes necesarios para a integración coa base de datos:

yarn add typeorm @nestjs/typeorm pg

En orde, para o que se necesita cada paquete:

1. typeorm - un paquete directamente do propio ORM;
2. @nestjs/typeorm - Paquete TypeORM para NestJS. Engade módulos para importar a módulos do proxecto, así como un conxunto de decoradores auxiliares;
3. pg - controlador para traballar con PostgreSQL.

Está ben, os paquetes están instalados, agora cómpre iniciar a propia base de datos. Para implementar a base de datos, usarei docker-compose.yml co seguinte contido:

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:8080

Como podes ver, este ficheiro configura o lanzamento de 2 contedores:

1. db é un contedor que contén directamente a base de datos. No noso caso, úsase a versión 11.2 de postgresql;
2. administrador—xestor de bases de datos. Ofrece unha interface web para ver e xestionar a base de datos.

Para traballar con conexións tcp, engadín a seguinte configuración.

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 here

Iso é todo, podes iniciar contedores co comando docker-compose up -d. Ou nunha consola separada co comando docker-compose up.

Así, instaláronse os paquetes, lanzouse a base de datos, só queda facerlles amigos entre eles. Para iso, cómpre engadir o seguinte ficheiro á raíz do proxecto: ormconfig.js:

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"
}
}

Esta configuración será usada para cli typeorm.

Vexamos esta configuración con máis detalle. Nas liñas 3 e 4 obtemos o nome de usuario e o contrasinal das variables de ambiente. Isto é conveniente cando tes varios ambientes (dev, stage, prod, etc.). Por defecto, o nome de usuario é postgres e o contrasinal é un exemplo. O resto da configuración é trivial, polo que nos centraremos só nos parámetros máis interesantes:

• sincronizar: indica se o esquema da base de datos debe crearse automaticamente cando se inicia a aplicación. Teña coidado con esta opción e non a use na produción, se non, perderá datos. Esta opción é conveniente ao desenvolver e depurar unha aplicación. Como alternativa a esta opción, pode usar o comando schema:sync desde CLI TypeORM.
• dropSchema: restablece o esquema cada vez que se establece unha conexión. Do mesmo xeito que a anterior, esta opción só debe usarse durante o desenvolvemento e a depuración da aplicación.
• entidades - que camiños buscar descricións de modelos. Teña en conta que se admite a busca por máscara.
• cli.entitiesDir é o directorio onde os modelos creados a partir da CLI TypeORM deben almacenarse por defecto.

Para que poidamos usar todas as funcións de TypeORM na nosa aplicación Nest, necesitamos importar o módulo TypeOrmModule в AppModule. Eses. teu AppModule quedará así:

aplicación.módulo.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 {}

Como podes ter notado, o método forRoot transfírese a mesma configuración para traballar coa base de datos que no ficheiro ormconfig.ts

O toque final segue sendo: engade varias tarefas para traballar con TypeORM en package.json. O feito é que a CLI está escrita en javascript e execútase no ambiente nodejs. Non obstante, todos os nosos modelos e migracións escribiranse a máquina. Polo tanto, é necesario transpilar as nosas migracións e modelos antes de usar a CLI. Para iso necesitamos o paquete ts-node:

yarn add -D ts-node

Despois diso, engade os comandos necesarios a 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"

O primeiro comando, typeorm, engade un envoltorio ts-node para executar o cli TypeORM. Os comandos restantes son atallos cómodos que, como desenvolvedor, utilizará case todos os días:
migration:generate — creando migracións baseadas nos cambios nos seus modelos.
migration:create — creando unha migración baleira.
migration:run - Lanzamento de migracións.
Pois xa está, engadimos os paquetes necesarios, configuramos a aplicación para que funcione coa base de datos tanto desde o cli como desde a propia aplicación, e tamén lanzamos o DBMS. É hora de engadir lóxica á nosa aplicación.

Instalación de paquetes para crear CRUD

Usando só Nest, podes crear unha API que che permita crear, ler, actualizar e eliminar unha entidade. Esta solución será o máis flexible posible, pero nalgúns casos será redundante. Por exemplo, se precisa crear rapidamente un prototipo, moitas veces pode sacrificar a flexibilidade pola velocidade de desenvolvemento. Moitos marcos proporcionan funcionalidades para xerar CRUD ao describir o modelo de datos dunha determinada entidade. E Nest non é unha excepción! Esta funcionalidade é proporcionada polo paquete @nestjsx/crud. As súas capacidades son moi interesantes:

• fácil instalación e configuración;
• independencia de DBMS;
• potente linguaxe de consulta coa capacidade de filtrar, paginar, ordenar, cargar relacións e entidades aniñadas, caché, etc.;
• paquete para xerar solicitudes no front-end;
• fácil anulación de métodos de controlador;
• pequena configuración;
• soporte de documentación de swagger.

A funcionalidade divídese en varios paquetes:

• @nestjsx/crud - o paquete básico que proporciona o decorador Crudo() para a xeración, configuración e validación de rutas;
• @nestjsx/crud-request — un paquete que proporciona un creador/analizador de consultas para o seu uso no frontend;
• @nestjsx/crud-typeorm — un paquete para a integración con TypeORM, que proporciona o servizo básico TypeOrmCrudService con métodos CRUD para traballar con entidades da base de datos.

Neste tutorial necesitaremos paquetes niñojsx/crud e niñojsx/crud-typeorm. Primeiro, poñémolos

yarn add @nestjsx/crud class-transformer class-validator

Paquetes transformador de clase и validador de clases nesta solicitude requírese unha descrición declarativa das regras de transformación de instancias modelo e validación de solicitudes entrantes, respectivamente. Estes paquetes son do mesmo autor, polo que as interfaces son similares.

Implementación directa de CRUD

Tomaremos unha lista de usuarios como modelo de exemplo. Os usuarios terán os seguintes campos: id, username, displayName, email. id - campo de incremento automático, email и username - campos únicos. É sinxelo! Só queda implementar a nosa idea en forma de aplicación Nest.
Primeiro cómpre crear un módulo users, que se encargará de traballar cos usuarios. Usemos o cli de NestJS e executemos o comando no directorio raíz do noso proxecto nest g module users.

usuarios do módulo nest g

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)

Neste módulo engadiremos un cartafol de entidades, onde teremos os modelos deste módulo. En particular, engadimos aquí o ficheiro user.entity.ts cunha descrición do modelo de usuario:

usuario.entidade.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;
}

Para que este modelo sexa "visto" pola nosa aplicación, é necesario no módulo UsersModule importar TypeOrmModule o seguinte contido:

usuarios.módulo.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 {}

É dicir, aquí importamos TypeOrmModule, onde como parámetro de método forFeature Indicamos unha lista de modelos relacionados con este módulo.

Só queda crear a entidade correspondente na base de datos. O mecanismo de migración serve para estes fins. Para crear unha migración baseada en cambios nos modelos, cómpre executar o comando npm run migration:generate -- CreateUserTable:

título de spoiler

$ npm run migration:generate -- CreateUserTable
Migration /home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts has been generated successfully.
Done in 1.96s.

Non tivemos que escribir a migración manualmente, todo pasou de xeito máxico. Non é un milagre! Non obstante, iso non é todo. Vexamos o ficheiro de migración creado:

1563346135367-CreateUserTable.ts

import {MigrationInterface, QueryRunner} from "typeorm";
export class CreateUserTable1563346816726 implements MigrationInterface {
public async up(queryRunner: QueryRunner): Promise<any> {
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<any> {
await queryRunner.query(`DROP TABLE "user"`);
}
}

Como podes ver, non só se xerou automaticamente o método para iniciar a migración, senón tamén o método para retroceder. Fantástico!
Só queda lanzar esta migración. Isto faise co seguinte comando:

npm run migration:run.

Isto é todo, agora os cambios de esquema migraron á base de datos.
A continuación, crearemos un servizo que se encargará de traballar cos usuarios e herdalo TypeOrmCrudService. O repositorio da entidade de interese debe pasarse ao parámetro do construtor pai, no noso caso User repositorio.

usuarios.servizo.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<User>{
constructor(@InjectRepository(User) usersRepository: Repository<User>){
super(usersRepository);
}
}

Necesitaremos este servizo no controlador users. Para crear un controlador, escriba na consola nest g controller users/controllers/users

usuarios/controladores/usuarios do controlador nest g

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)

Abramos este controlador e editámolo para engadir un pouco de maxia niñojsx/crud. Por clase UsersController Engadimos un decorador como este:

@Crud({
model: {
type: User
}
})

Crudo é un decorador que engade ao controlador os métodos necesarios para traballar co modelo. O tipo de modelo indícase no campo model.type configuracións do decorador.
O segundo paso é implementar a interface CrudController<User>. O código do controlador "ensamblado" ten este aspecto:

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<User>{
constructor(public service: UsersService){}
}

E é todo! Agora o controlador admite todo o conxunto de operacións co modelo. Non me cres? Probemos a nosa aplicación en acción!

Creando un script de consulta en TestMace

Para probar o noso servizo utilizaremos un IDE para traballar coa API TestMace. Por que TestMace? En comparación con produtos similares, ten as seguintes vantaxes:

• poderoso traballo con variables. Neste momento, existen varios tipos de variables, cada unha delas desempeña un papel específico: variables incorporadas, variables dinámicas, variables de ambiente. Cada variable pertence a un nodo con soporte para o mecanismo de herdanza;
• Crea facilmente scripts sen programación. Isto será discutido a continuación;
• un formato lexible por humanos que permite gardar o proxecto en sistemas de control de versións;
• autocompletado, resaltado de sintaxe, resaltado de valores variables;
• Compatibilidade coa descrición da API coa posibilidade de importar desde Swagger.

Imos iniciar o noso servidor co comando npm start e tentar acceder á lista de usuarios. A lista de usuarios, a xulgar pola configuración do noso controlador, pódese obter a partir do URL localhost:3000/users. Imos facer unha solicitude a este URL.
Despois de executar TestMace podes ver unha interface como esta:

Na parte superior esquerda hai unha árbore de proxecto cun nodo raíz Proxecto. Tentemos crear a primeira solicitude para obter unha lista de usuarios. Para iso imos crear Paso de solicitude nodo Isto faise no menú contextual do nodo Proxecto Engadir nodo -> RequestStep.

No campo URL, pegue localhost:3000/users e execute a solicitude. Recibiremos o código 200 cunha matriz baleira no corpo da resposta. É comprensible, aínda non engadimos ninguén.
Imos crear un script que incluirá os seguintes pasos:

1. crear un usuario;
2. solicitude do ID do usuario recén creado;
3. eliminando por ID de usuario creado no paso 1.

Entón, imos. Por comodidade, creemos un nodo como Dobrador. Esencialmente, este é só un cartafol no que gardaremos o script completo. Para crear un nodo Cartafol, seleccione Proxecto no menú contextual do nodo Engadir nodo -> Cartafol. Imos chamar ao nodo verificar-crear. Dentro dun nodo verificar-crear Imos crear a nosa primeira solicitude para crear un usuario. Chamemos ao nodo recén creado crear-usuario. É dicir, neste momento a xerarquía dos nodos terá o seguinte aspecto:

Imos á pestana aberta crear-usuario nodo. Introduzamos os seguintes parámetros para a solicitude:

• Tipo de solicitude: POST
• URL: host local: 3000/usuarios
• Corpo: JSON con valor {"email": "[email protected]", "displayName": "New user", "username": "user"}

Cumprimos esta petición. A nosa aplicación di que o rexistro foi creado.

Ben, imos comprobar este feito. Para poder operar co id do usuario creado en pasos posteriores, este parámetro debe ser gardado. O mecanismo é perfecto para iso. variables dinámicas. Usemos o noso exemplo para ver como traballar con eles. Na pestana analizada da resposta, xunto ao nodo de identificación no menú contextual, seleccione o elemento Asignar a variable. No cadro de diálogo debes establecer os seguintes parámetros:

• Nodo — en cal dos antepasados ​​crear unha variable dinámica. Imos escoller verificar-crear
• Nome variable - o nome desta variable. Imos chamar userId.

Así é o proceso de creación dunha variable dinámica:

Agora, cada vez que se execute esta consulta, actualizarase o valor da variable dinámica. E porque as variables dinámicas admiten o mecanismo de herdanza xerárquica, variable userId estará dispoñible en descendentes verificar-crear nodo de calquera nivel de anidación.
Esta variable serános útil na próxima solicitude. É dicir, solicitaremos o usuario recén creado. Como fillo dun nodo verificar-crear crearemos unha solicitude comprobar se existe con parámetro url iguais localhost:3000/users/${$dynamicVar.userId}. Ver deseño ${variable_name} isto é obter o valor dunha variable. Porque Temos unha variable dinámica, polo que para obtela é necesario acceder ao obxecto $dynamicVar, é dicir, acceder completamente a unha variable dinámica userId quedará así ${$dynamicVar.userId}. Imos executar a solicitude e asegúrese de que os datos son solicitados correctamente.
O último paso que queda é solicitar a eliminación. Necesitamos non só para comprobar o funcionamento da eliminación, senón tamén, por así dicir, para limpar nós mesmos na base de datos, porque Os campos de correo electrónico e de nome de usuario son únicos. Entón, no nodo de verificación-crear, crearemos unha solicitude de eliminación de usuario cos seguintes parámetros

• Tipo de solicitude: DELETE
• URL - localhost:3000/users/${$dynamicVar.userId}

Imos lanzar. Agardamos. Gozamos co resultado)

Ben, agora podemos executar este script completo en calquera momento. Para executar o script, cómpre seleccionar no menú contextual verificar-crear elemento nodo Correr.

Os nodos do script executaranse un despois do outro
Podes gardar este script no teu proxecto executando Ficheiro -> Gardar proxecto.

Conclusión

Todas as funcións das ferramentas utilizadas simplemente non poderían encaixar no formato deste artigo. En canto ao principal culpable - o paquete niñojsx/crud - os seguintes temas permanecen descubertos:

• validación personalizada e transformación de modelos;
• potente linguaxe de consulta e o seu cómodo uso na parte frontal;
• redefinir e engadir novos métodos aos controladores de crud;
• apoio fanfarrón;
• xestión de caché.

Non obstante, mesmo o que se describe no artigo é suficiente para entender que mesmo un marco empresarial como NestJS ten ferramentas para a creación rápida de prototipos de aplicacións. E un IDE tan xenial TestMace permite manter un ritmo determinado.

Código fonte deste artigo, xunto co proxecto TestMace, dispoñible no repositorio https://github.com/TestMace/nest-rest. Para abrir un proxecto TestMace simplemente faino na aplicación Ficheiro -> Abrir proxecto.

Fonte: www.habr.com