För närvarande har REST API blivit en standard för webbapplikationsutveckling, vilket gör att utvecklingen kan delas upp i oberoende delar. Olika populära ramverk som Angular, React, Vue och andra används för närvarande för UI. Backend-utvecklare kan välja mellan en mängd olika språk och ramverk. Idag skulle jag vilja prata om ett sådant ramverk som NestJS. Vi är inne TestMace Vi använder det aktivt för interna projekt. Använder bo och paket @nestjsx/crud, kommer vi att skapa en enkel CRUD-applikation.

Varför NestJS

Nyligen har en hel del backend-ramverk dykt upp i JavaScript-communityt. Och om de när det gäller funktionalitet ger liknande kapacitet som Nest, så vinner den definitivt i en sak - det här är arkitekturen. Följande NestJS-funktioner låter dig skapa industriella applikationer och skala utveckling till stora team:

• använder TypeScript som huvudutvecklingsspråk. Även om NestJS stöder JavaScript, kanske vissa funktioner inte fungerar, speciellt om vi pratar om tredjepartspaket;
• närvaron av en DI-behållare, vilket gör att du kan skapa löst kopplade komponenter;
• Ramverkets funktionalitet är uppdelad i oberoende utbytbara komponenter. Till exempel, under huven som ram kan den användas som uttrycker, och fasta, för att arbeta med databasen, ger nest out of the box bindningar till typorm, mungo, uppföljare;
• NestJS är plattformsoberoende och stöder REST, GraphQL, Websockets, gRPC, etc.

Själva ramverket är inspirerat av Angular frontend-ramverket och har konceptuellt mycket gemensamt med det.

Installation av NestJS och implementering av projektet

Nest innehåller ett paket bo/cli, som gör att du snabbt kan distribuera ett grundläggande programramverk. Låt oss installera detta paket globalt:

npm install --global @nest/cli

Efter installationen kommer vi att generera det grundläggande ramverket för vår applikation med namnet bo-rest. Detta görs med kommandot nest new nest-rest.

bo ny bo-vila

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

Vi kommer att välja garn som vår paketansvarig.
Vid det här laget kan du starta servern med kommandot npm start och går till adressen http://localhost:3000 du kan se huvudsidan. Det är dock inte därför vi har samlats här och vi går vidare.

Inrätta arbete med databasen

Jag valde PostrgreSQL som DBMS för den här artikeln. Det finns ingen tvist om smak; enligt min mening är detta det mest mogna DBMS, som har alla nödvändiga funktioner. Som redan nämnts tillhandahåller Nest integration med olika paket för att arbeta med databaser. Därför att Eftersom mitt val föll på PostgreSQL skulle det vara logiskt att välja TypeORM som en ORM. Låt oss installera de nödvändiga paketen för integration med databasen:

yarn add typeorm @nestjs/typeorm pg

I ordning, vad varje paket behövs för:

1. typeorm - ett paket direkt från själva ORM;
2. @nestjs/typeorm - TypeORM-paket för NestJS. Lägger till moduler för import till projektmoduler, samt en uppsättning medhjälpare dekoratörer;
3. pg - drivrutin för att arbeta med PostgreSQL.

Okej, paketen är installerade, nu måste du starta själva databasen. För att distribuera databasen kommer jag att använda docker-compose.yml med följande innehåll:

docker-compose.yml

version: '3.1'

services:
  db:
    image: postgres:11.2
    restart: always
    environment:
      POSTGRES_PASSWORD: example
    volumes:
      - ../db:/var/lib/postgresql/data
      - ./postgresql.conf:/etc/postgresql/postgresql.conf
    ports:
      - 5432:5432
  adminer:
    image: adminer
    restart: always
    ports:
      - 8080:8080

Som du kan se konfigurerar den här filen lanseringen av 2 behållare:

1. db är en behållare som direkt innehåller databasen. I vårt fall används postgresql version 11.2;
2. adminer—databashanterare. Tillhandahåller ett webbgränssnitt för visning och hantering av databasen.

För att arbeta med tcp-anslutningar lade jag till följande konfiguration.

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

Det är allt, du kan starta behållare med kommandot docker-compose up -d. Eller i en separat konsol med kommandot docker-compose up.

Så, paketen har installerats, databasen har lanserats, allt som återstår är att göra dem vänner med varandra. För att göra detta måste du lägga till följande fil i projektets rot: 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"
}
}

Denna konfiguration kommer att användas för cli typorm.

Låt oss titta på denna konfiguration mer detaljerat. På rad 3 och 4 får vi användarnamn och lösenord från miljövariablerna. Detta är praktiskt när du har flera miljöer (dev, scen, prod, etc). Som standard är användarnamnet postgres och lösenordet är ett exempel. Resten av konfigurationen är trivial, så vi kommer bara att fokusera på de mest intressanta parametrarna:

• synchronize - Indikerar om databasschemat ska skapas automatiskt när programmet startar. Var försiktig med det här alternativet och använd det inte i produktionen, annars kommer du att förlora data. Det här alternativet är praktiskt när du utvecklar och felsöker en applikation. Som ett alternativ till detta alternativ kan du använda kommandot schema:sync från CLI TypeORM.
• dropSchema - återställ schemat varje gång en anslutning upprättas. Precis som den föregående bör det här alternativet endast användas under utveckling och felsökning av applikationen.
• entiteter - vilka vägar man ska leta efter beskrivningar av modeller. Observera att sökning med mask stöds.
• cli.entitiesDir är katalogen där modeller skapade från TypeORM CLI ska lagras som standard.

För att vi ska kunna använda alla funktioner i TypeORM i vår Nest-applikation måste vi importera modulen TypeOrmModule в AppModule. De där. din AppModule kommer se ut så här:

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

Som du kanske har märkt, metoden forRoot samma konfiguration för att arbeta med databasen överförs som i filen ormconfig.ts

Sista handen återstår - lägg till flera uppgifter för att arbeta med TypeORM i package.json. Faktum är att CLI är skrivet i javascript och körs i nodejs-miljön. Alla våra modeller och migreringar kommer dock att skrivas på maskin. Därför är det nödvändigt att transpilera våra migrationer och modeller innan du använder CLI. För detta behöver vi ts-node-paketet:

yarn add -D ts-node

Efter det lägger du till de nödvändiga kommandona till 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"

Det första kommandot, typeorm, lägger till ett ts-nod-omslag för att köra TypeORM-cli. De återstående kommandona är bekväma genvägar som du som utvecklare kommer att använda nästan varje dag:
migration:generate — skapa migrering baserat på ändringar i dina modeller.
migration:create — skapa en tom migrering.
migration:run — inleda migrationer.
Tja, det är det nu, vi har lagt till de nödvändiga paketen, konfigurerat applikationen för att fungera med databasen både från cli och från själva applikationen, och även lanserat DBMS. Det är dags att lägga till logik i vår applikation.

Installerar paket för att skapa CRUD

Med endast Nest kan du skapa ett API som låter dig skapa, läsa, uppdatera och ta bort en enhet. Denna lösning kommer att vara så flexibel som möjligt, men i vissa fall blir den överflödig. Till exempel, om du snabbt behöver skapa en prototyp, kan du ofta offra flexibilitet för snabb utveckling. Många ramverk tillhandahåller funktionalitet för att generera CRUD genom att beskriva datamodellen för en viss entitet. Och Nest är inget undantag! Denna funktion tillhandahålls av paketet @nestjsx/crud. Dess kapacitet är mycket intressant:

• enkel installation och konfiguration;
• DBMS-oberoende;
• kraftfullt frågespråk med möjlighet att filtrera, paginera, sortera, ladda relationer och kapslade enheter, cachelagring, etc.;
• paket för att generera förfrågningar på front-end;
• enkel åsidosättande av kontrollermetoder;
• liten konfiguration;
• swagger dokumentationsstöd.

Funktionen är uppdelad i flera paket:

• @nestjsx/crud - grundpaketet som dekoratören tillhandahåller Rå() för generering, konfiguration och validering av rutt.
• @nestjsx/crud-request — ett paket som tillhandahåller en frågebyggare/parser för användning på frontendsidan;
• @nestjsx/crud-typeorm — ett paket för integration med TypeORM, som tillhandahåller den grundläggande TypeOrmCrudService-tjänsten med CRUD-metoder för att arbeta med enheter i databasen.

I den här handledningen behöver vi paket bojsx/crud och bojsx/crud-typeorm. Låt oss först lägga dem

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

paket klass-transformator и klassvalidator i denna ansökan krävs för en deklarativ beskrivning av reglerna för transformering av modellinstanser respektive validering av inkommande förfrågningar. Dessa paket är från samma författare, så gränssnitten är liknande.

Direkt implementering av CRUD

Vi tar en lista över användare som exempelmodell. Användare kommer att ha följande fält: id, username, displayName, email. id - fält för automatisk ökning, email и username - unika fält. Det är enkelt! Allt som återstår är att implementera vår idé i form av en Nest-applikation.
Först måste du skapa en modul users, som kommer att ansvara för att arbeta med användare. Låt oss använda cli från NestJS och köra kommandot i rotkatalogen för vårt projekt nest g module users.

nest g-modulanvändare

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)

I den här modulen kommer vi att lägga till en entitetsmapp, där vi kommer att ha modellerna för denna modul. Låt oss särskilt lägga till filen user.entity.ts med en beskrivning av användarmodellen:

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

För att denna modell ska "seas" av vår applikation krävs den i modulen UsersModule importera TypeOrmModule följande innehåll:

användare.modul.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 {}

Det vill säga här importerar vi TypeOrmModule, där som en metodparameter forFeature Vi anger en lista över modeller relaterade till denna modul.

Allt som återstår är att skapa motsvarande enhet i databasen. Migrationsmekanismen tjänar för dessa ändamål. För att skapa en migrering baserad på ändringar i modeller måste du köra kommandot npm run migration:generate -- CreateUserTable:

spoiler titel

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

Vi behövde inte skriva migreringen manuellt, allt hände magiskt. Är inte detta ett mirakel! Det är dock inte allt. Låt oss ta en titt på den skapade migreringsfilen:

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

Som du kan se genererades inte bara metoden för att starta migreringen automatiskt, utan också metoden för att återställa den. Fantastisk!
Allt som återstår är att rulla ut denna migration. Detta görs med följande kommando:

npm run migration:run.

Det var allt, nu har schemaändringarna migrerat till databasen.
Därefter kommer vi att skapa en tjänst som kommer att ansvara för att arbeta med användare och ärva den från TypeOrmCrudService. Lagret för den aktuella enheten måste skickas till parametern för den överordnade konstruktören, i vårt fall User förvaret.

användare.tjänst.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);
}
}

Vi kommer att behöva den här tjänsten i kontrollern users. För att skapa en kontroller, skriv in konsolen nest g controller users/controllers/users

nest g controller användare/kontroller/användare

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)

Låt oss öppna den här kontrollern och redigera den för att lägga till lite magi bojsx/crud. Per klass UsersController Låt oss lägga till en dekoratör så här:

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

Rå är en dekoratör som lägger till kontrollenheten de nödvändiga metoderna för att arbeta med modellen. Modelltypen anges i fältet model.type dekoratörskonfigurationer.
Det andra steget är att implementera gränssnittet CrudController<User>. "Sammansatt" styrenhetskod ser ut så här:

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

Och det är allt! Nu stöder styrenheten hela uppsättningen operationer med modellen! Tro mig inte? Låt oss prova vår applikation i aktion!

Skapa ett frågeskript i TestMace

För att testa vår tjänst kommer vi att använda en IDE för att arbeta med API TestMace. Varför TestMace? Jämfört med liknande produkter har den följande fördelar:

• kraftfullt arbete med variabler. För tillfället finns det flera typer av variabler, som var och en spelar en specifik roll: inbyggda variabler, dynamiska variabler, miljövariabler. Varje variabel tillhör en nod med stöd för arvsmekanismen;
• Skapa enkelt skript utan programmering. Detta kommer att diskuteras nedan;
• ett mänskligt läsbart format som låter dig spara projektet i versionskontrollsystem;
• autokomplettering, syntaxmarkering, variabelvärdesmarkering;
• API-beskrivningsstöd med möjlighet att importera från Swagger.

Låt oss starta vår server med kommandot npm start och försök komma åt listan över användare. Listan över användare, att döma av vår styrenhetskonfiguration, kan erhållas från webbadressen localhost:3000/users. Låt oss göra en begäran till den här webbadressen.
Efter att ha kört TestMace kan du se ett gränssnitt så här:

Längst upp till vänster finns ett projektträd med en rotnod Projekt. Låt oss försöka skapa den första begäran för att få en lista över användare. För detta kommer vi att skapa RequestStep nod Detta görs i snabbmenyn för projektnoden Lägg till nod -> RequestStep.

I URL-fältet, klistra in localhost:3000/users och kör begäran. Vi kommer att få kod 200 med en tom array i svarskroppen. Det är förståeligt, vi har inte lagt till någon ännu.
Låt oss skapa ett skript som innehåller följande steg:

1. skapa en användare;
2. begäran om id för den nyskapade användaren;
3. radering av användar-id skapat i steg 1.

Låt oss gå. För enkelhetens skull, låt oss skapa en nodliknande mapp. I huvudsak är detta bara en mapp där vi kommer att spara hela skriptet. För att skapa en mappnod, välj Projekt från nodens snabbmeny Lägg till nod -> Mapp. Låt oss ringa noden check-skapa. Inuti en nod check-skapa Låt oss skapa vår första begäran om att skapa en användare. Låt oss kalla den nyskapade noden skapa användare. Det vill säga, för tillfället kommer nodhierarkin att se ut så här:

Låt oss gå till den öppna fliken skapa användare nod. Låt oss ange följande parametrar för begäran:

• Begärantyp - POST
• URL - localhost:3000/users
• Kropp - JSON med värde {"email": "[email protected]", "displayName": "New user", "username": "user"}

Låt oss uppfylla denna begäran. Vår ansökan säger att posten har skapats.

Nåväl, låt oss kontrollera detta faktum. För att kunna arbeta med den skapade användarens id i efterföljande steg måste denna parameter sparas. Mekanismen är perfekt för detta. dynamiska variabler. Låt oss använda vårt exempel för att titta på hur man arbetar med dem. På den analyserade fliken i svaret, bredvid id-noden i snabbmenyn, välj objektet Tilldela till variabel. I dialogrutan måste du ställa in följande parametrar:

• Nod — i vilken av förfäderna som ska skapa en dynamisk variabel. Låt oss välja check-skapa
• Variabelnamn — Namnet på denna variabel. Låt oss ringa userId.

Så här ser processen att skapa en dynamisk variabel ut:

Nu, varje gång den här frågan exekveras, kommer värdet på den dynamiska variabeln att uppdateras. Och eftersom dynamiska variabler stödjer mekanismen för hierarkiskt arv, variabel userId kommer att finnas i ättlingar check-skapa nod på valfri häckningsnivå.
Denna variabel kommer att vara användbar för oss i nästa begäran. Vi kommer nämligen att begära den nyskapade användaren. Som ett barn till en nod check-skapa vi kommer att skapa en förfrågan kontrollera om det finns med parameter url lika localhost:3000/users/${$dynamicVar.userId}. Visa design ${variable_name} detta är att få värdet av en variabel. Därför att Vi har en dynamisk variabel, så för att få den behöver du komma åt objektet $dynamicVar, d.v.s. helt åtkomst till en dynamisk variabel userId kommer att se ut så här ${$dynamicVar.userId}. Låt oss utföra begäran och se till att uppgifterna efterfrågas korrekt.
Det sista steget som återstår är att begära radering. Vi behöver det inte bara för att kontrollera hur raderingen fungerar, utan också, så att säga, för att städa efter oss i databasen, eftersom E-post- och användarnamnsfälten är unika. Så i check-create-noden kommer vi att skapa en radera-användarförfrågan med följande parametrar

• Begärantyp - DELETE
• url - localhost:3000/users/${$dynamicVar.userId}

Låt oss starta. Vi väntar. Vi njuter av resultatet)

Nåväl, nu kan vi köra hela det här skriptet när som helst. För att köra skriptet måste du välja från snabbmenyn check-skapa nodobjekt Körning.

Noderna i skriptet kommer att exekveras en efter en
Du kan spara det här skriptet i ditt projekt genom att köra Arkiv -> Spara projekt.

Slutsats

Alla funktioner i de använda verktygen kunde helt enkelt inte passa in i formatet för den här artikeln. När det gäller huvudboven - paketet bojsx/crud - följande ämnen förblir avslöjade:

• anpassad validering och transformation av modeller;
• kraftfullt frågespråk och dess bekväma användning längst fram;
• omdefiniera och lägga till nya metoder till crud controllers;
• swagger stöd;
• cachehantering.

Men även det som beskrivs i artikeln är tillräckligt för att förstå att även ett sådant företagsramverk som NestJS har verktyg för snabb applikationsprototyping. Och en så cool IDE-liknande TestMace låter dig hålla en given takt.

Källkod för den här artikeln, tillsammans med projektet TestMace, tillgänglig i förvaret https://github.com/TestMace/nest-rest. För att öppna ett projekt TestMace gör det bara i appen Arkiv -> Öppna projekt.

Källa: will.com