Actualmente, la API REST se ha convertido en el estándar para el desarrollo de aplicaciones web, lo que le permite dividir el desarrollo en partes independientes. Para la interfaz de usuario, actualmente se utilizan varios marcos populares como Angular, React, Vue y otros. Los desarrolladores de backend pueden elegir entre una amplia variedad de lenguajes y marcos. Hoy me gustaría hablar sobre un marco como nidojs. Estamos en PruebaMaza Lo usamos activamente para proyectos internos. Usando nido y paquete @nestjsx/crud, crearemos una aplicación CRUD simple.

¿Por qué NestJS?

Recientemente, han aparecido muchos marcos de back-end en la comunidad de JavaScript. Y si en términos de funcionalidad brindan oportunidades similares a Nest, entonces definitivamente gana en una cosa: esto es arquitectura. Las siguientes funciones de NestJS le permiten crear aplicaciones industriales y escalar el desarrollo a grandes equipos:

• utilizando TypeScript como lenguaje principal de desarrollo. Aunque NestJS es compatible con JavaScript, es posible que algunas de las funciones no funcionen, especialmente cuando se trata de paquetes de terceros;
• la presencia de un contenedor DI, que le permite crear componentes débilmente acoplados;
• la funcionalidad del marco en sí se divide en componentes intercambiables independientes. Por ejemplo, debajo del capó como marco se puede usar como expresoY sujetar, para trabajar con la base de datos Nest lista para usar, proporciona enlaces a tipificar, mangosta, secuelizar;
• NestJS es independiente de la plataforma y admite REST, GraphQL, Websockets, gRPC, etc.

El marco en sí está inspirado en el marco de interfaz de Angular y conceptualmente tiene mucho en común con él.

Instalación de NestJS e implementación de un proyecto

Nest contiene un paquete nido/cli, que le permite implementar rápidamente un marco de aplicación básico. Instale este paquete globalmente:

npm install --global @nest/cli

Luego de la instalación, generaremos el framework básico de nuestra aplicación con el nombre nido-rest. Esto se hace usando el comando nest new nest-rest.

nido nuevo nido-descanso

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

Elegiremos yarn como nuestro administrador de paquetes.
Por ahora, puede iniciar el servidor con el comando npm start y yendo a la dirección http://localhost:3000 Puedes ver la página principal. Sin embargo, esto no es para lo que estamos aquí y seguimos adelante.

Configurar el trabajo con la base de datos

Como DBMS para este artículo, elegí PostrgreSQL. No hay disputa sobre gustos, en mi opinión, este es el DBMS más maduro que tiene todas las características necesarias. Como ya se mencionó, Nest proporciona integración con varios paquetes para trabajar con bases de datos. Porque Dado que mi elección recayó en PostgreSQL, sería lógico elegir TypeORM como ORM. Instale los paquetes necesarios para la integración con la base de datos:

yarn add typeorm @nestjs/typeorm pg

En orden, para qué sirve cada paquete:

1. typeorm - un paquete directamente desde el propio ORM;
2. @nestjs/typeorm - Paquete TypeORM para NestJS. Agrega módulos para importar a módulos de proyecto, así como un conjunto de decoradores auxiliares;
3. pg es un controlador para trabajar con PostgreSQL.

Bien, los paquetes están instalados, ahora necesita iniciar la base de datos. Para implementar la base, usaré docker-compose.yml con el siguiente contenido:

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 puede ver, este archivo configura el lanzamiento de 2 contenedores:

1. db es un contenedor directamente con una base de datos. En nuestro caso se utiliza postgresql versión 11.2;
2. administrador - administrador de base de datos. Proporciona una interfaz web para ver y administrar la base de datos.

Para trabajar con conexiones tcp, agregué la siguiente 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

Eso es todo, puedes ejecutar los contenedores con el comando docker-compose up -d. O en una consola separada con el comando docker-compose up.

Entonces, se instalaron los paquetes, se lanzó la base, queda por hacerlos amigos entre sí. Para ello, agregue el archivo ormconfig.js a la raíz del proyecto con el siguiente contenido:

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 se utilizará para cli typeorm.

Echemos un vistazo más de cerca a esta configuración. En las líneas 3 y 4 obtenemos el nombre de usuario y la contraseña de las variables de entorno. Esto es útil cuando tiene múltiples entornos (dev, stage, prod, etc.). El nombre de usuario predeterminado es postgres, la contraseña es ejemplo. De lo contrario, la configuración es trivial, por lo que nos centraremos solo en los parámetros más interesantes:

• sincronizar Especifica si el esquema de la base de datos debe crearse automáticamente cuando se inicia la aplicación. Tenga cuidado con esta opción y no la use en producción, de lo contrario perderá datos. Esta opción es útil al desarrollar y depurar una aplicación. Como alternativa a esta opción, puede utilizar el comando schema:sync de CLI TipoORM.
• dropSchema: elimina el esquema cada vez que se establece una conexión. Además, al igual que la anterior, esta opción debe utilizarse únicamente durante el desarrollo y depuración de la aplicación.
• entidades: qué caminos buscar para la descripción de los modelos. Tenga en cuenta que se admite la búsqueda de máscaras.
• cli.entitiesDir es el directorio donde los modelos creados desde CLI TypeORM deben agregarse de forma predeterminada.

Para que podamos usar todas las funciones de TypeORM en nuestra aplicación Nest, necesitamos importar el módulo TypeOrmModule в AppModule. Aquellos. su AppModule se verá 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 habrás notado, en el método forRoot se pasa la misma configuración para trabajar con la base de datos que en el archivo ormconfig.ts

Queda el toque final: agregar algunas tareas para trabajar con TypeORM en package.json. El hecho es que la CLI está escrita en javascript y se ejecuta en el entorno nodejs. Sin embargo, todos nuestros modelos y migraciones estarán escritos a máquina. Por lo tanto, es necesario transpilar nuestras migraciones y modelos antes de usar la CLI. Para hacer esto, necesitamos el paquete ts-node:

yarn add -D ts-node

Después de eso, agregue los 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"

El primer comando, typeorm, agrega un contenedor ts-node para iniciar el cli de TypeORM. El resto de los comandos son atajos útiles que usted, como desarrollador, usará casi todos los días:
migration:generate - crear migraciones basadas en cambios en sus modelos.
migration:create - creando una migración vacía.
migration:run - iniciar migraciones.
Bueno, ahora eso es todo seguro, agregamos los paquetes necesarios, configuramos la aplicación para que funcione con la base de datos tanto desde el cli como desde la propia aplicación, y también lanzamos el DBMS. Es hora de agregar lógica a nuestra aplicación.

Instalación de paquetes para crear CRUD

Usando solo Nest, puede crear una API que le permita crear, leer, actualizar y eliminar una entidad. Tal solución será lo más flexible posible, pero en algunos casos será redundante. Por ejemplo, si necesita crear rápidamente un prototipo, a menudo puede sacrificar la flexibilidad en aras de la velocidad de desarrollo. Muchos marcos brindan la funcionalidad de generar CRUD al describir el modelo de datos de una entidad en particular. ¡Y Nest no es una excepción! Esta funcionalidad es proporcionada por el paquete @nestjsx/crud. Sus posibilidades son muy interesantes:

• fácil instalación y configuración;
• independencia del DBMS;
• potente lenguaje de consulta con la capacidad de filtrar, paginar, ordenar, cargar relaciones y entidades anidadas, almacenamiento en caché, etc.;
• un paquete para generar solicitudes para el front-end;
• fácil redefinición de métodos de controlador;
• pequeña configuración;
• soporte de documentación swagger.

La funcionalidad se divide en varios paquetes:

• @nestjsx/crud - el paquete base proporcionado por el decorador crud() para la generación, configuración y validación de rutas;
• @nestjsx/crud-request - un paquete que proporciona un generador / analizador de consultas para usar en el lado de la interfaz;
• @nestjsx/crud-typeform - un paquete para la integración con TypeORM, que proporciona un servicio TypeOrmCrudService básico con métodos CRUD para trabajar con entidades en la base de datos.

Para esta guía, necesitaremos paquetes nidojsx/crud y nidojsx/crud-typeform. Primero, pongámoslos

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

Paquetes transformador de clase и validador de clase en esta aplicación son necesarios para la descripción declarativa de las reglas para transformar instancias de modelo y validar solicitudes entrantes, respectivamente. Estos paquetes son del mismo autor, por lo que las interfaces son similares.

Implementación directa de CRUD

Como ejemplo de modelo, tomaremos una lista de usuarios. Los usuarios dispondrán de los siguientes campos: id, username, displayName, email. id - campo de incremento automático, email и username - campos únicos. ¡Todo es sencillo! Queda por realizar nuestra idea en forma de una aplicación Nest.
Primero necesitas crear un módulo. usersquien será el responsable de trabajar con los usuarios. Usemos el cli de NestJS, y en el directorio raíz de nuestro proyecto ejecutaremos el comando nest g module users.

usuarios del 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)

En este módulo añadiremos la carpeta de entidades, donde tendremos los modelos de este módulo. En particular, agreguemos el archivo user.entity.ts aquí con una descripción del modelo de usuario:

usuario.entidad.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 sea "visto" por nuestra aplicación es necesario en el módulo UsersModule importar TypeOrmModule el siguiente contenido:

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

Así que aquí estamos importando TypeOrmModule, donde como parámetro del método forFeature especificar la lista de modelos relacionados con este módulo.

Queda por crear la entidad correspondiente en la base de datos. A estos efectos se utiliza el mecanismo de las migraciones. Para crear una migración basada en cambios de modelo, ejecute el comando npm run migration:generate -- CreateUserTable:

título del spoiler

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

No tuvimos que escribir la migración a mano, todo sucedió mágicamente. ¿No es eso un milagro? Sin embargo, esto no es todo. Echemos un vistazo al archivo de migración generado:

1563346135367-Crear tabla de usuario.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 puede ver, no solo se generó automáticamente el método para iniciar la migración, sino también el método para revertirla. ¡Fantástico!
Solo queda rodar esta migración. Esto se hace con el siguiente comando:

npm run migration:run.

Eso es todo, ahora los cambios de esquema han migrado a la base de datos.
A continuación, crearemos un servicio que se encargará de trabajar con los usuarios y lo heredaremos de TypeOrmCrudService. Es necesario pasar el repositorio de la entidad de interés al parámetro del constructor padre, en nuestro caso User repositorio.

usuarios.servicio.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);
}
}

Necesitamos este servicio en el controlador. users. Para crear un controlador, escriba en la consola nest g controller users/controllers/users

usuarios/controladores/usuarios del 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)

Abra este controlador y edítelo para agregar algo de magia. nidojsx/crudo. por clase UsersController Agreguemos un decorador como este:

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

crud es un decorador que agrega los métodos necesarios al controlador para trabajar con el modelo. El tipo de modelo se indica en el campo. model.type configuración del decorador.
El segundo paso es implementar la interfaz. CrudController<User>. El código del controlador "ensamblado" se ve así:

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){}
}

¡Y es todo! ¡Ahora el controlador admite todo el conjunto de operaciones con el modelo! ¿No crees? ¡Probemos nuestra aplicación en acción!

Solicitudes de secuencias de comandos en TestMace

Para probar nuestro servicio, usaremos el IDE para trabajar con la API PruebaMaza. ¿Por qué probar Mac? En comparación con productos similares, tiene las siguientes ventajas:

• Potente trabajo con variables. Por el momento, existen varios tipos de variables, cada una de las cuales cumple una función específica: variables integradas, variables dinámicas, variables de entorno. Cada variable pertenece a algún nodo con soporte para el mecanismo de herencia;
• secuencias de comandos sencillas sin programación. Esto será discutido abajo;
• formato legible por humanos que le permite guardar el proyecto en sistemas de control de versiones;
• autocompletado, resaltado de sintaxis, resaltado de valores variables;
• Soporte de descripción de API con la capacidad de importar desde Swagger.

Comencemos nuestro servidor con el comando npm start e intente acceder a la lista de usuarios. La lista de usuarios, a juzgar por la configuración de nuestro controlador, se puede obtener de la url localhost:3000/users. Hagamos una solicitud para esta url.
Después de ejecutar TestMace, puede ver esta interfaz:

En la parte superior izquierda está el árbol del proyecto con el nodo raíz. Proyecto. Intentemos crear la primera solicitud para obtener una lista de usuarios. Para ello, crearemos Paso de solicitud nodo. Esto se hace en el menú contextual del nodo Proyecto. Agregar nodo -> RequestStep.

Pegue localhost:3000/users en el campo URL y ejecute la solicitud. Obtenemos 200 códigos con una matriz vacía en el cuerpo de la respuesta. Es comprensible, no hemos añadido a nadie todavía.
Vamos a crear un script que incluirá los siguientes pasos:

1. creación de usuarios;
2. consulta por id del usuario recién creado;
3. eliminar por ID de usuario creado en el paso 1.

Entonces vamos. Por comodidad, vamos a crear un nodo como carpeta. De hecho, esta es solo una carpeta en la que guardaremos todo el script. Para crear un nodo Carpeta, en el menú contextual del nodo Proyecto, seleccione Agregar nodo -> Carpeta. Llamemos al nodo verificar-crear. Dentro del nodo verificar-crear Vamos a crear nuestra primera solicitud para crear un usuario. Vamos a nombrar el nodo recién creado crear usuario. Es decir, por el momento la jerarquía de nodos se verá así:

Vamos a la pestaña abierta crear usuario nodo. Ingresemos los siguientes parámetros para la solicitud:

• Tipo de solicitud - POST
• URL - localhost:3000/usuarios
• Cuerpo - JSON con valor {"email": "[email protected]", "displayName": "New user", "username": "user"}

Ejecutemos esta solicitud. Nuestra aplicación dice que la entrada ha sido creada.

Bueno, vamos a comprobar este hecho. Para poder operar con el id del usuario creado en pasos posteriores, se debe guardar este parámetro. Este mecanismo es perfecto para esto. variables dinámicas. Echemos un vistazo a cómo trabajamos con ellos usando nuestro ejemplo. En la pestaña analizada de la respuesta, en el nodo id en el menú contextual, seleccione el elemento Asignar a variable. Los siguientes parámetros deben especificarse en el cuadro de diálogo:

• Nodo - en cuál de los ancestros crear una variable dinámica. Vamos a escoger verificar-crear
• Nombre de la variable es el nombre de esta variable. Llamemos userId.

Así es como se ve el proceso de creación de una variable dinámica:

Ahora, cada vez que se ejecute esta consulta, se actualizará el valor de la variable dinámica. Y desde variables dinámicas apoyan el mecanismo de herencia jerárquica, variable userId estará disponible en descendientes verificar-crear nodo de cualquier nivel de anidamiento.
En la próxima solicitud, esta variable nos será útil. Es decir, solicitaremos un usuario recién creado. Como hijo de un nodo verificar-crear vamos a crear una solicitud comprobar si existe con parámetro url igual localhost:3000/users/${$dynamicVar.userId}. Ver construcción ${variable_name} es obtener el valor de una variable. Porque tenemos una variable dinámica, entonces para obtenerla necesitas referirte al objeto $dynamicVar, es decir, acceder completamente a una variable dinámica userId se verá así ${$dynamicVar.userId}. Ejecutemos la solicitud y asegurémonos de que los datos se solicitan correctamente.
Queda el último toque: realizar una solicitud de eliminación. Lo necesitamos no solo para verificar el funcionamiento de la eliminación, sino también, por así decirlo, para limpiar nuestra base de datos, porque los campos de correo electrónico y nombre de usuario son únicos. Entonces, en el nodo verificar-crear, crearemos una solicitud de eliminación de usuario con los siguientes parámetros

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

Lanzamos. Esperamos. disfruta el resultado)

Bueno, ahora podemos ejecutar este script por completo en cualquier momento. Para ejecutar el script, seleccione del menú contextual verificar-crear punto de nudo Ejecutar.

Los nodos en el script se ejecutarán uno tras otro.
Puede guardar este script en su proyecto ejecutando Archivo -> Guardar proyecto.

Conclusión

Todos los chips de las herramientas utilizadas simplemente no cabrían en el formato de este artículo. En cuanto al principal culpable - el paquete nidojsx/crud: los siguientes temas quedaron sin cubrir:

• validación personalizada y transformación de modelos;
• lenguaje de consulta potente y su uso conveniente en el frente;
• redefiniendo y agregando nuevos métodos a los controladores crud;
• soporte de arrogancia;
• gestión de almacenamiento en caché.

Sin embargo, incluso lo que se describe en el artículo es suficiente para comprender que incluso un marco empresarial como NestJS tiene herramientas para la creación rápida de prototipos de aplicaciones. Y un IDE tan genial como PruebaMaza le permite mantener un ritmo establecido.

El código fuente de este artículo, junto con el proyecto PruebaMaza, disponible en el repositorio https://github.com/TestMace/nest-rest. Para abrir un proyecto PruebaMaza basta con ejecutar en la aplicación Archivo -> Abrir proyecto.

Fuente: habr.com