Attualmente, l'API REST è diventata uno standard per lo sviluppo di applicazioni web, consentendo di suddividere lo sviluppo in parti indipendenti. Vari framework popolari come Angular, React, Vue e altri sono attualmente utilizzati per l'interfaccia utente. Gli sviluppatori backend possono scegliere tra un'ampia varietà di linguaggi e framework. Oggi vorrei parlare di un quadro come NestJS. Siamo dentro Test Mace Lo utilizziamo attivamente per progetti interni. Utilizzando nido e pacchetto @nestjsx/crud, creeremo una semplice applicazione CRUD.

Perché NestJS

Recentemente, nella comunità JavaScript sono apparsi numerosi framework di backend. E se in termini di funzionalità forniscono capacità simili a Nest, allora in una cosa vince sicuramente: questa è l'architettura. Le seguenti funzionalità di NestJS ti consentono di creare applicazioni industriali e adattare lo sviluppo a team di grandi dimensioni:

• utilizzando TypeScript come linguaggio di sviluppo principale. Nonostante NestJS supporti JavaScript, alcune funzionalità potrebbero non funzionare, soprattutto se parliamo di pacchetti di terze parti;
• la presenza di un contenitore DI, che consente di creare componenti liberamente accoppiati;
• La funzionalità del framework stesso è suddivisa in componenti intercambiabili indipendenti. Ad esempio, sotto il cofano può essere utilizzato come struttura esprimereE fastificare, per lavorare con il database, Nest out of the box fornisce collegamenti a tipo standard, mangusta, seguito;
• NestJS è indipendente dalla piattaforma e supporta REST, GraphQL, Websockets, gRPC, ecc.

Il framework stesso è ispirato al framework frontend Angular e concettualmente ha molto in comune con esso.

Installazione di NestJS e distribuzione del progetto

Nest contiene un pacchetto nido/cli, che consente di distribuire rapidamente un framework applicativo di base. Installiamo questo pacchetto a livello globale:

npm install --global @nest/cli

Dopo l'installazione, genereremo il framework di base della nostra applicazione con il nome nido-resT. Questo viene fatto usando il comando nest new nest-rest.

nido nuovo nido-riposo

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

Sceglieremo Yarn come nostro gestore di pacchetti.
A questo punto potete avviare il server con il comando npm start e andare all'indirizzo http://localhost:3000 puoi vedere la pagina principale. Tuttavia non è questo il motivo per cui ci siamo riuniti qui e andiamo avanti.

Impostazione del lavoro con il database

Ho scelto PostrgreSQL come DBMS per questo articolo. Non si discute sui gusti, secondo me questo è il DBMS più maturo, dotato di tutte le funzionalità necessarie. Come già accennato, Nest fornisce l'integrazione con vari pacchetti per lavorare con i database. Perché Poiché la mia scelta è caduta su PostgreSQL, sarebbe logico scegliere TypeORM come ORM. Installiamo i pacchetti necessari per l'integrazione con il database:

yarn add typeorm @nestjs/typeorm pg

In ordine, a cosa serve ciascun pacchetto:

1. typeorm - un pacchetto direttamente dall'ORM stesso;
2. @nestjs/typeorm - Pacchetto TypeORM per NestJS. Aggiunge moduli per l'importazione nei moduli del progetto, nonché una serie di decoratori di supporto;
3. pg - driver per lavorare con PostgreSQL.

Ok, i pacchetti sono installati, ora devi avviare il database stesso. Per distribuire il database, utilizzerò docker-compose.yml con il seguente contenuto:

finestra mobile-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

Come puoi vedere, questo file configura il lancio di 2 contenitori:

1. db è un contenitore che contiene direttamente il database. Nel nostro caso viene utilizzata la versione 11.2 di postgresql;
2. amministratore: gestore del database. Fornisce un'interfaccia web per la visualizzazione e la gestione del database.

Per lavorare con le connessioni TCP, ho aggiunto la seguente configurazione.

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

Questo è tutto, puoi avviare i contenitori con il comando docker-compose up -d. Oppure in una console separata con il comando docker-compose up.

Quindi i pacchetti sono stati installati, il database è stato lanciato, non resta che farli diventare amici tra loro. Per fare ciò, è necessario aggiungere il seguente file alla root del progetto: 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"
}
}

Questa configurazione verrà utilizzata per cli typeorm.

Diamo un'occhiata a questa configurazione in modo più dettagliato. Nelle righe 3 e 4 otteniamo il nome utente e la password dalle variabili d'ambiente. Ciò è utile quando si hanno diversi ambienti (sviluppo, stage, produzione, ecc.). Per impostazione predefinita, il nome utente è postgres e la password è example. Il resto della configurazione è banale, quindi ci concentreremo solo sui parametri più interessanti:

• sincronizza: indica se lo schema del database deve essere creato automaticamente all'avvio dell'applicazione. Fai attenzione a questa opzione e non utilizzarla in produzione, altrimenti perderai dati. Questa opzione è utile durante lo sviluppo e il debug di un'applicazione. In alternativa a questa opzione è possibile utilizzare il comando schema:sync dalla CLI TypeORM.
• dropSchema: reimposta lo schema ogni volta che viene stabilita una connessione. Proprio come la precedente, questa opzione dovrebbe essere utilizzata solo durante lo sviluppo e il debug dell'applicazione.
• entità: quali percorsi cercare per le descrizioni dei modelli. Tieni presente che è supportata la ricerca per maschera.
• cli.entitiesDir è la directory in cui i modelli creati dalla CLI TypeORM devono essere archiviati per impostazione predefinita.

Per poter utilizzare tutte le funzionalità di TypeORM nella nostra applicazione Nest, dobbiamo importare il modulo TypeOrmModule в AppModule. Quelli. tuo AppModule sarà simile a questo:

app.modulo.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 {}

Come avrai notato, il metodo forRoot viene trasferita la stessa configurazione per lavorare con il database come nel file ormconfig.ts

Resta il tocco finale: aggiungi diverse attività per lavorare con TypeORM in package.json. Il fatto è che la CLI è scritta in javascript e viene eseguita nell'ambiente nodejs. Tuttavia, tutti i nostri modelli e migrazioni saranno scritti in dattiloscritto. Pertanto, è necessario tradurre le nostre migrazioni e i nostri modelli prima di utilizzare la CLI. Per questo abbiamo bisogno del pacchetto ts-node:

yarn add -D ts-node

Successivamente, aggiungi i comandi necessari 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"

Il primo comando, typeorm, aggiunge un wrapper ts-node per eseguire la CLI TypeORM. I restanti comandi sono comode scorciatoie che tu, come sviluppatore, utilizzerai quasi ogni giorno:
migration:generate — creazione di migrazioni basate sui cambiamenti nei tuoi modelli.
migration:create — creando una migrazione vuota.
migration:run — avviare le migrazioni.
Bene, ora è tutto, abbiamo aggiunto i pacchetti necessari, configurato l'applicazione per funzionare con il database sia dalla CLI che dall'applicazione stessa e abbiamo anche lanciato il DBMS. È ora di aggiungere logica alla nostra applicazione.

Installazione di pacchetti per la creazione di CRUD

Utilizzando solo Nest, puoi creare un'API che ti consente di creare, leggere, aggiornare ed eliminare un'entità. Questa soluzione sarà quanto più flessibile possibile, ma in alcuni casi sarà ridondante. Ad esempio, se devi creare rapidamente un prototipo, spesso puoi sacrificare la flessibilità a favore della velocità di sviluppo. Molti framework forniscono funzionalità per generare CRUD descrivendo il modello dati di una determinata entità. E Nest non fa eccezione! Questa funzionalità è fornita dal pacchetto @nestjsx/crud. Le sue capacità sono molto interessanti:

• facilità di installazione e configurazione;
• Indipendenza dal DBMS;
• potente linguaggio di query con la possibilità di filtrare, impaginare, ordinare, caricare relazioni ed entità nidificate, memorizzazione nella cache, ecc.;
• pacchetto per la generazione di richieste sul front-end;
• facile override dei metodi del controller;
• piccola configurazione;
• supporto per la documentazione spavalda.

La funzionalità è suddivisa in diversi pacchetti:

• @nestjsx/crud - il pacchetto base fornito dal decoratore crudele() per la generazione, configurazione e convalida del percorso;
• @nestjsx/crud-request — un pacchetto che fornisce un generatore/parser di query da utilizzare sul lato frontend;
• @nestjsx/crud-typeorm — un pacchetto per l'integrazione con TypeORM, che fornisce il servizio TypeOrmCrudService di base con metodi CRUD per lavorare con le entità nel database.

In questo tutorial avremo bisogno dei pacchetti nidojsx/crud e nidojsx/crud-typeorm. Per prima cosa, mettiamoli

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

pacchetti trasformatore di classe и validatore di classe in questa applicazione è richiesta una descrizione dichiarativa delle regole rispettivamente per la trasformazione delle istanze del modello e la convalida delle richieste in entrata. Questi pacchetti provengono dallo stesso autore, quindi le interfacce sono simili.

Implementazione diretta del CRUD

Prenderemo un elenco di utenti come modello di esempio. Gli utenti avranno i seguenti campi: id, username, displayName, email. id - campo ad incremento automatico, email и username - campi unici. È semplice! Non resta che implementare la nostra idea sotto forma di applicazione Nest.
Per prima cosa devi creare un modulo users, che sarà responsabile della collaborazione con gli utenti. Usiamo la cli di NestJS ed eseguiamo il comando nella directory root del nostro progetto nest g module users.

utenti del modulo 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)

In questo modulo aggiungeremo una cartella delle entità, dove avremo i modelli di questo modulo. In particolare aggiungiamo qui il file user.entity.ts con la descrizione del modello utente:

utente.entità.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;
}

Affinché questo modello possa essere “visto” dalla nostra applicazione, è necessario nel modulo UsersModule importare TypeOrmModule come segue:

utenti.modulo.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 {}

Cioè, qui importiamo TypeOrmModule, dove come parametro del metodo forFeature Indichiamo un elenco di modelli correlati a questo modulo.

Non resta che creare l'entità corrispondente nel database. Il meccanismo di migrazione serve a questi scopi. Per creare una migrazione basata sulle modifiche nei modelli, è necessario eseguire il comando npm run migration:generate -- CreateUserTable:

titolo 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 abbiamo dovuto scrivere manualmente la migrazione, tutto è avvenuto magicamente. Non è questo un miracolo! Ma non è tutto. Diamo un'occhiata al file di migrazione creato:

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"`);
}
}

Come puoi vedere, non solo è stato generato automaticamente il metodo per avviare la migrazione, ma anche il metodo per ripristinarla. Fantastico!
Non resta che implementare questa migrazione. Questo viene fatto con il seguente comando:

npm run migration:run.

Questo è tutto, ora le modifiche allo schema sono state trasferite nel database.
Successivamente, creeremo un servizio che sarà responsabile della collaborazione con gli utenti e da cui erediterà TypeOrmCrudService. Il repository dell'entità di interesse deve essere passato al parametro del costruttore genitore, nel nostro caso User deposito.

utenti.servizio.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);
}
}

Avremo bisogno di questo servizio nel controller users. Per creare un controller, digita nella console nest g controller users/controllers/users

utenti/controller/utenti del controller 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)

Apriamo questo controller e modifichiamolo per aggiungere un po' di magia nidojsx/crud. Per classe UsersController Aggiungiamo un decoratore come questo:

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

crudele è un decoratore che aggiunge al controller i metodi necessari per lavorare con il modello. Il tipo di modello è indicato nel campo model.type configurazioni del decoratore.
Il secondo passo è implementare l'interfaccia CrudController<User>. Il codice del controller "assemblato" è simile al seguente:

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 questo è tutto! Ora il controller supporta l'intera serie di operazioni con il modello! Non mi credi? Proviamo la nostra applicazione in azione!

Creazione di uno script di query in TestMace

Per testare il nostro servizio utilizzeremo un IDE per lavorare con l'API Test Mace. Perchè TestMace? Rispetto a prodotti simili, presenta i seguenti vantaggi:

• lavoro potente con le variabili. Al momento esistono diversi tipi di variabili, ognuna delle quali svolge un ruolo specifico: variabili integrate, variabili dinamiche, variabili d'ambiente. Ogni variabile appartiene ad un nodo con supporto per il meccanismo di ereditarietà;
• Crea facilmente script senza programmazione. Questo sarà discusso di seguito;
• un formato leggibile dall'uomo che consente di salvare il progetto nei sistemi di controllo della versione;
• completamento automatico, evidenziazione della sintassi, evidenziazione del valore della variabile;
• Supporto per la descrizione API con la possibilità di importare da Swagger.

Avviamo il nostro server con il comando npm start e prova ad accedere all'elenco degli utenti. L'elenco degli utenti, a giudicare dalla configurazione del nostro controller, può essere ottenuto dall'URL localhost:3000/users. Facciamo una richiesta a questo URL.
Dopo aver eseguito TestMace puoi vedere un'interfaccia come questa:

In alto a sinistra c'è un albero del progetto con un nodo radice Progetto. Proviamo a creare la prima richiesta per ottenere un elenco di utenti. Per questo creeremo Richiesta Passo nodo Questo viene fatto nel menu contestuale del nodo Progetto Aggiungi nodo -> RequestStep.

Nel campo URL, incolla localhost:3000/users ed esegui la richiesta. Riceveremo il codice 200 con un array vuoto nel corpo della risposta. È comprensibile, non abbiamo ancora aggiunto nessuno.
Creiamo uno script che includerà i seguenti passaggi:

1. creazione di un utente;
2. richiesta dell'id dell'utente appena creato;
3. eliminazione tramite ID utente creato nel passaggio 1.

Quindi andiamo. Per comodità, creiamo un nodo simile cartella. Essenzialmente, questa è solo una cartella in cui salveremo l'intero script. Per creare un nodo Cartella, selezionare Progetto dal menu contestuale del nodo Aggiungi nodo -> Cartella. Chiamiamo il nodo controlla-crea. All'interno di un nodo controlla-crea Creiamo la nostra prima richiesta per creare un utente. Chiamiamo il nodo appena creato creare un utente. Cioè, al momento la gerarchia dei nodi sarà simile a questa:

Andiamo alla scheda aperta creare un utente nodo. Inseriamo i seguenti parametri per la richiesta:

• Tipo di richiesta: POST
• URL: host locale:3000/utenti
• Corpo: JSON con valore {"email": "[email protected]", "displayName": "New user", "username": "user"}

Soddisfiamo questa richiesta. La nostra applicazione dice che il record è stato creato.

Bene, controlliamo questo fatto. Per poter operare con l'id dell'utente creato nei passaggi successivi è necessario salvare questo parametro. Il meccanismo è perfetto per questo. variabili dinamiche. Usiamo il nostro esempio per vedere come lavorare con loro. Nella scheda analizzata della risposta, accanto al nodo ID nel menu contestuale, seleziona l'elemento Assegna alla variabile. Nella finestra di dialogo è necessario impostare i seguenti parametri:

• Nodo — in quale degli antenati creare una variabile dinamica. Scegliamo controlla-crea
• Nome della variabile — il nome di questa variabile. Chiamiamo userId.

Ecco come si presenta il processo di creazione di una variabile dinamica:

Ora, ogni volta che viene eseguita questa query, il valore della variabile dinamica verrà aggiornato. E perché le variabili dinamiche supportano il meccanismo di ereditarietà gerarchica, variabile userId sarà disponibile nei discendenti controlla-crea nodo di qualsiasi livello di nidificazione.
Questa variabile ci sarà utile nella prossima richiesta. Ovvero, richiederemo l'utente appena creato. Come figlio di un nodo controlla-crea creeremo una richiesta controlla se esiste con parametro url pari localhost:3000/users/${$dynamicVar.userId}. Visualizza il disegno ${variable_name} questo sta ottenendo il valore di una variabile. Perché Abbiamo una variabile dinamica, quindi per ottenerla è necessario accedere all'oggetto $dynamicVar, ovvero accedendo completamente a una variabile dinamica userId apparirà così ${$dynamicVar.userId}. Eseguiamo la richiesta e assicuriamoci che i dati siano richiesti correttamente.
L'ultimo passaggio rimasto è richiedere la cancellazione. Ne abbiamo bisogno non solo per verificare l'operazione di cancellazione, ma anche, per così dire, per ripulire il database, perché I campi email e nome utente sono unici. Quindi, nel nodo check-create creeremo una richiesta delete-user con i seguenti parametri

• Tipo di richiesta: ELIMINA
• URL - localhost:3000/users/${$dynamicVar.userId}

Lanciamo. Aspettiamo. Ci godiamo il risultato)

Bene, ora possiamo eseguire l'intero script in qualsiasi momento. Per eseguire lo script è necessario selezionare dal menu contestuale controlla-crea elemento del nodo Correre.

I nodi nello script verranno eseguiti uno dopo l'altro
Puoi salvare questo script nel tuo progetto eseguendo File -> Salva progetto.

conclusione

Tutte le funzionalità degli strumenti utilizzati semplicemente non potevano rientrare nel formato di questo articolo. Per quanto riguarda il principale colpevole: il pacchetto nidojsx/crud - i seguenti argomenti rimangono scoperti:

• validazione personalizzata e trasformazione dei modelli;
• potente linguaggio di query e suo comodo utilizzo in primo piano;
• ridefinire e aggiungere nuovi metodi ai crud controller;
• supporto spavaldo;
• gestione della cache.

Tuttavia, anche quanto descritto nell'articolo è sufficiente per comprendere che anche un framework aziendale come NestJS dispone di strumenti per la prototipazione rapida delle applicazioni. E un IDE così interessante come Test Mace ti consente di mantenere un determinato ritmo.

Codice sorgente per questo articolo, insieme al progetto Test Mace, disponibile nel repository https://github.com/TestMace/nest-rest. Per aprire un progetto Test Mace fallo semplicemente nell'app File -> Apri progetto.

Fonte: habr.com