В момента REST API се превърна в стандарт за разработка на уеб приложения, което позволява разработката да бъде разделена на независими части. В момента за UI се използват различни популярни рамки като Angular, React, Vue и други. Backend разработчиците могат да избират от голямо разнообразие от езици и рамки. Днес бих искал да говоря за такава рамка като NestJS. Вътре сме TestMace Използваме го активно за вътрешни проекти. Използване на гнездо и пакет @nestjsx/crud, ще създадем просто CRUD приложение.

Защо NestJS

Наскоро в общността на JavaScript се появиха доста бекенд рамки. И ако по отношение на функционалността те предоставят подобни възможности на Nest, то в едно нещо определено печели - това е архитектурата. Следните функции на NestJS ви позволяват да създавате индустриални приложения и да мащабирате разработката до големи екипи:

• използвайки TypeScript като основен език за разработка. Въпреки че NestJS поддържа JavaScript, някои функции може да не работят, особено ако говорим за пакети на трети страни;
• наличието на DI контейнер, който ви позволява да създавате слабо свързани компоненти;
• Функционалността на самата рамка е разделена на независими взаимозаменяеми компоненти. Например, под капака като рамка може да се използва като изразявамИ бързо, за да работите с базата данни, гнездото извън кутията предоставя обвързвания към typeorm, мангуста, продължавам;
• NestJS е агностик на платформата и поддържа REST, GraphQL, Websockets, gRPC и др.

Самата рамка е вдъхновена от фронтенд рамката на Angular и концептуално има много общо с нея.

Инсталиране на NestJS и внедряване на проекта

Nest съдържа пакет гнездо/cli, което ви позволява бързо да внедрите основна рамка на приложения. Нека инсталираме този пакет глобално:

npm install --global @nest/cli

След инсталирането ще генерираме основната рамка на нашето приложение с името гнездо-резT. Това става с помощта на командата nest new nest-rest.

гнездо ново гнездо-почивка

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

Ние ще изберем yarn като наш пакетен мениджър.
В този момент можете да стартирате сървъра с командата npm start и отивам на адреса http://localhost:3000 можете да видите главната страница. Но не затова сме се събрали тук и продължаваме напред.

Настройка на работа с базата данни

Избрах PostrgreSQL като СУБД за тази статия. За вкусовете спор няма, според мен това е най-зрялата СУБД, притежаваща всички необходими възможности. Както вече споменахме, Nest осигурява интеграция с различни пакети за работа с бази данни. защото Тъй като моят избор падна върху PostgreSQL, би било логично да избера TypeORM като ORM. Нека инсталираме необходимите пакети за интеграция с базата данни:

yarn add typeorm @nestjs/typeorm pg

За какво е необходим всеки пакет:

1. typeorm - пакет директно от самата ORM;
2. @nestjs/typeorm - TypeORM пакет за NestJS. Добавя модули за импортиране в модули на проекта, както и набор от помощни декоратори;
3. pg - драйвер за работа с PostgreSQL.

Добре, пакетите са инсталирани, сега трябва да стартирате самата база данни. За да разположа базата данни, ще използвам docker-compose.yml със следното съдържание:

докер-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

Както можете да видите, този файл конфигурира стартирането на 2 контейнера:

1. db е контейнер, съдържащ директно базата данни. В нашия случай се използва postgresql версия 11.2;
2. администратор—мениджър на база данни. Предоставя уеб интерфейс за преглед и управление на базата данни.

За да работя с tcp връзки, добавих следната конфигурация.

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

Това е всичко, можете да стартирате контейнери с командата docker-compose up -d. Или в отделна конзола с командата docker-compose up.

И така, пакетите са инсталирани, базата данни е стартирана, остава само да ги направим приятели един с друг. За да направите това, трябва да добавите следния файл към корена на проекта: 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"
}
}

Тази конфигурация ще се използва за cli typeorm.

Нека разгледаме тази конфигурация по-подробно. На редове 3 и 4 получаваме потребителското име и паролата от променливите на средата. Това е удобно, когато имате няколко среди (dev, stage, prod и т.н.). По подразбиране потребителското име е postgres, а паролата е примерна. Останалата част от конфигурацията е тривиална, така че ще се съсредоточим само върху най-интересните параметри:

• synchronize - Показва дали схемата на базата данни трябва да се създава автоматично при стартиране на приложението. Бъдете внимателни с тази опция и не я използвайте в производството, в противен случай ще загубите данни. Тази опция е удобна при разработване и отстраняване на грешки в приложение. Като алтернатива на тази опция можете да използвате командата schema:sync от CLI TypeORM.
• dropSchema - нулиране на схемата всеки път, когато се установи връзка. Точно както предишната, тази опция трябва да се използва само по време на разработката и отстраняването на грешки в приложението.
• entities – по кои пътища да се търсят описания на модели. Моля, обърнете внимание, че се поддържа търсене по маска.
• cli.entitiesDir е директорията, където моделите, създадени от TypeORM CLI, трябва да се съхраняват по подразбиране.

За да можем да използваме всички функции на TypeORM в нашето приложение Nest, трябва да импортираме модула TypeOrmModule в AppModule. Тези. Вашият AppModule ще изглежда така:

app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import * as process from "process";
const username = process.env.POSTGRES_USER || 'postgres';
const password = process.env.POSTGRES_PASSWORD || 'example';
@Module({
imports: [
TypeOrmModule.forRoot({
type: 'postgres',
host: 'localhost',
port: 5432,
username,
password,
database: 'postgres',
entities: [__dirname + '/**/*.entity{.ts,.js}'],
synchronize: true,
}),
],
controllers: [AppController],
providers: [AppService],
})
export class AppModule {}

Както може би сте забелязали, методът forRoot прехвърля се същата конфигурация за работа с базата данни, както във файла ormconfig.ts

Остава последният щрих - добавете няколко задачи за работа с TypeORM в package.json. Факт е, че CLI е написан на javascript и работи в среда nodejs. Всички наши модели и миграции обаче ще бъдат написани на машина. Следователно е необходимо да транспилираме нашите миграции и модели, преди да използваме CLI. За целта се нуждаем от пакета ts-node:

yarn add -D ts-node

След това добавете необходимите команди към 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"

Първата команда, typeorm, добавя обвивка на ts-node за стартиране на TypeORM cli. Останалите команди са удобни преки пътища, които вие, като разработчик, ще използвате почти всеки ден:
migration:generate — създаване на миграции въз основа на промени във вашите модели.
migration:create — създаване на празна миграция.
migration:run — стартиране на миграции.
Е, това е сега, добавихме необходимите пакети, конфигурирахме приложението да работи с базата данни както от cli, така и от самото приложение, а също така стартирахме СУБД. Време е да добавим логика към нашето приложение.

Инсталиране на пакети за създаване на CRUD

Използвайки само Nest, можете да създадете API, който ви позволява да създавате, четете, актуализирате и изтривате обект. Това решение ще бъде възможно най-гъвкаво, но в някои случаи ще бъде излишно. Например, ако трябва бързо да създадете прототип, често можете да пожертвате гъвкавостта за скорост на разработка. Много рамки предоставят функционалност за генериране на CRUD чрез описание на модела на данни на определен обект. И Nest не е изключение! Тази функционалност се предоставя от пакета @nestjsx/crud. Възможностите му са много интересни:

• лесен монтаж и конфигуриране;
• СУБД независимост;
• мощен език за заявки с възможност за филтриране, страниране, сортиране, зареждане на връзки и вложени обекти, кеширане и т.н.;
• пакет за генериране на заявки във фронт-енд;
• лесно пренастройване на методите на контролера;
• малка конфигурация;
• поддръжка на документация за размахване.

Функционалността е разделена на няколко пакета:

• @nestjsx/crud - основният пакет, който предоставя декораторът Crud() за генериране на маршрут, конфигурация и валидиране;
• @nestjsx/crud-request — пакет, който предоставя създател на заявки/парсер за използване от страна на интерфейса;
• @nestjsx/crud-typeorm — пакет за интеграция с TypeORM, предоставящ базовата услуга TypeOrmCrudService с CRUD методи за работа с обекти в базата данни.

В този урок ще ни трябват пакети гнездоjsx/crud и гнездоjsx/crud-typeorm. Първо, нека ги поставим

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

Пакети клас-трансформатор и клас-валидатор в това приложение са необходими за декларативно описание на правилата за трансформиране на моделни екземпляри и съответно валидиране на входящи заявки. Тези пакети са от един и същи автор, така че интерфейсите са подобни.

Директно внедряване на CRUD

Ще вземем списък с потребители като примерен модел. Потребителите ще имат следните полета: id, username, displayName, email. id - автоматично нарастващо поле, email и username - уникални полета. Просто е! Остава само да реализираме нашата идея под формата на Nest приложение.
Първо трябва да създадете модул users, който ще отговаря за работата с потребителите. Нека използваме cli от NestJS и изпълним командата в главната директория на нашия проект nest g module users.

потребители на nest g module

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)

В този модул ще добавим папка entities, където ще имаме моделите на този модул. По-специално, нека добавим тук файла user.entity.ts с описание на потребителския модел:

user.entity.ts

import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';
@Entity()
export class User {
@PrimaryGeneratedColumn()
id: string;
@Column({unique: true})
email: string;
@Column({unique: true})
username: string;
@Column({nullable: true})
displayName: string;
}

За да може този модел да се „види” от нашето приложение, е необходимо в модула UsersModule внос TypeOrmModule следното съдържание:

потребители.модул.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 {}

Тоест тук внасяме TypeOrmModule, където като параметър на метода forFeature Посочваме списък с модели, свързани с този модул.

Остава само да създадете съответния обект в базата данни. За тези цели служи механизмът за миграция. За да създадете миграция въз основа на промени в моделите, трябва да изпълните командата npm run migration:generate -- CreateUserTable:

спойлер заглавие

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

Не трябваше да пишем миграцията ръчно, всичко се случи магически. Това не е ли чудо! Това обаче не е всичко. Нека да разгледаме създадения файл за миграция:

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

Както можете да видите, не само методът за стартиране на миграцията беше автоматично генериран, но и методът за нейното връщане назад. Фантастично!
Всичко, което остава, е да внедрим тази миграция. Това става със следната команда:

npm run migration:run.

Това е всичко, сега промените в схемата са мигрирали към базата данни.
След това ще създадем услуга, която ще отговаря за работата с потребителите и ще я наследи от TypeOrmCrudService. Хранилището на обекта, представляващ интерес, трябва да бъде предадено на параметъра на родителския конструктор, в нашия случай User хранилище.

users.service.ts

import { Injectable } from '@nestjs/common';
import { TypeOrmCrudService } from '@nestjsx/crud-typeorm';
import { User } from '../../entities/user.entity';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
@Injectable()
export class UsersService extends TypeOrmCrudService<User>{
constructor(@InjectRepository(User) usersRepository: Repository<User>){
super(usersRepository);
}
}

Тази услуга ще ни е необходима в контролера users. За да създадете контролер, въведете в конзолата nest g controller users/controllers/users

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)

Нека отворим този контролер и го редактираме, за да добавим малко магия гнездоjsx/crud. На клас UsersController Нека добавим декоратор като този:

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

Crud е декоратор, който добавя към контролера необходимите методи за работа с модела. Типът модел е посочен в полето model.type конфигурации на декоратора.
Втората стъпка е внедряването на интерфейса CrudController<User>. „Сглобеният“ код на контролера изглежда така:

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

И това е всичко! Сега контролерът поддържа целия набор от операции с модела! не ми вярваш Нека опитаме нашето приложение в действие!

Създаване на скрипт за заявка в TestMace

За да тестваме нашата услуга, ще използваме IDE за работа с API TestMace. Защо TestMace? В сравнение с подобни продукти, той има следните предимства:

• мощна работа с променливи. В момента има няколко вида променливи, всяка от които играе специфична роля: вградени променливи, динамични променливи, променливи на средата. Всяка променлива принадлежи към възел с поддръжка за механизма за наследяване;
• Създавайте лесно скриптове без програмиране. Това ще бъде обсъдено по-долу;
• четим от човека формат, който ви позволява да запазите проекта в системи за контрол на версиите;
• автоматично довършване, осветяване на синтаксис, осветяване на променлива стойност;
• Поддръжка на описание на API с възможност за импортиране от Swagger.

Нека стартираме нашия сървър с командата npm start и опитайте да получите достъп до списъка с потребители. Списъкът с потребители, съдейки по конфигурацията на нашия контролер, може да бъде получен от url localhost:3000/users. Нека направим заявка на този url.
След стартиране на TestMace можете да видите интерфейс като този:

Горе вляво има дърво на проекта с основен възел Проект. Нека се опитаме да създадем първата заявка за получаване на списък с потребители. За това ще създадем RequestStep възел Това се прави в контекстното меню на възела Project Добавете възел -> RequestStep.

В полето URL поставете localhost:3000/users и изпълнете заявката. Ще получим код 200 с празен масив в тялото на отговора. Разбираемо е, все още не сме добавили никого.
Нека създадем скрипт, който ще включва следните стъпки:

1. създаване на потребител;
2. заявка за ID на новосъздадения потребител;
3. изтриване от потребителски идентификатор, създаден в стъпка 1.

И така, да вървим. За удобство нека създадем възел като Папка. По същество това е просто папка, в която ще запазим целия скрипт. За да създадете възел Папка, изберете Проект от контекстното меню на възела Добавяне на възел -> Папка. Нека извикаме възела проверка-създаване. Вътре във възел проверка-създаване Нека създадем нашата първа заявка за създаване на потребител. Нека извикаме новосъздадения възел създаване на потребител. Тоест, в момента йерархията на възлите ще изглежда така:

Да отидем на отворения раздел създаване на потребител възел. Нека въведем следните параметри за заявката:

• Тип заявка - POST
• URL - localhost:3000/потребители
• Тяло - JSON със стойност {"email": "[email protected]", "displayName": "New user", "username": "user"}

Нека изпълним тази молба. Приложението ни казва, че записът е създаден.

Е, нека проверим този факт. За да работите с идентификатора на създадения потребител в следващите стъпки, този параметър трябва да бъде записан. Механизмът е идеален за това. динамични променливи. Нека използваме нашия пример, за да видим как да работим с тях. В анализирания раздел на отговора, до id възела в контекстното меню, изберете елемента Присвояване на променлива. В диалоговия прозорец трябва да зададете следните параметри:

• Възел — в кой от предците да се създаде динамична променлива. Да изберем проверка-създаване
• Име на променливата — името на тази променлива. Да се ​​обадим userId.

Ето как изглежда процесът на създаване на динамична променлива:

Сега всеки път, когато се изпълни тази заявка, стойността на динамичната променлива ще се актуализира. И защото динамични променливи поддържат механизма на йерархично наследяване, променлива userId ще бъде наличен в наследници проверка-създаване възел на всяко ниво на влагане.
Тази променлива ще ни бъде полезна при следваща заявка. А именно, ще поискаме новосъздадения потребител. Като дете на възел проверка-създаване ще създадем заявка проверете дали съществува с параметър url равен localhost:3000/users/${$dynamicVar.userId}. Вижте дизайна ${variable_name} това е получаване на стойността на променлива. защото Имаме динамична променлива, така че за да я получите, трябва да имате достъп до обекта $dynamicVar, т.е. пълен достъп до динамична променлива userId ще изглежда така ${$dynamicVar.userId}. Нека да изпълним заявката и да се уверим, че данните са заявени правилно.
Последната оставаща стъпка е да поискате изтриване. Нужен ни е не само за да проверим действието на изтриването, но и, така да се каже, за да почистим след себе си в базата данни, т.к. Полетата за имейл и потребителско име са уникални. И така, във възела за създаване на проверка ще създадем заявка за изтриване на потребител със следните параметри

• Тип заявка - ИЗТРИВАНЕ
• url - localhost:3000/users/${$dynamicVar.userId}

Да стартираме. чакаме Радваме се на резултата)

Е, сега можем да стартираме целия този скрипт по всяко време. За да стартирате скрипта, трябва да изберете от контекстното меню проверка-създаване възел елемент бягане.

Възлите в скрипта ще се изпълняват един след друг
Можете да запишете този скрипт във вашия проект, като изпълните Файл -> Запазване на проекта.

Заключение

Всички функции на използваните инструменти просто не могат да се поберат във формата на тази статия. Що се отнася до главния виновник – опаковката гнездоjsx/crud - следните теми остават непокрити:

• персонализирано валидиране и трансформиране на модели;
• мощен език за заявки и удобното му използване отпред;
• предефиниране и добавяне на нови методи към crud контролерите;
• поддръжка на перчене;
• управление на кеширане.

Но дори това, което е описано в статията, е достатъчно, за да разберем, че дори такава корпоративна рамка като NestJS има инструменти за бързо създаване на прототипи на приложения. И такава готина IDE като TestMace ви позволява да поддържате зададено темпо.

Изходният код за тази статия, заедно с проекта TestMace, налични в хранилището https://github.com/TestMace/nest-rest. За отваряне на проект TestMace просто го направете в приложението Файл -> Отворете проекта.

Източник: www.habr.com