Επί του παρόντος, το REST API έχει γίνει ένα πρότυπο για την ανάπτυξη εφαρμογών ιστού, επιτρέποντας την ανάπτυξη να χωριστεί σε ανεξάρτητα μέρη. Διάφορα δημοφιλή πλαίσια, όπως το Angular, το React, το Vue και άλλα χρησιμοποιούνται επί του παρόντος για τη διεπαφή χρήστη. Οι προγραμματιστές backend μπορούν να επιλέξουν από μια μεγάλη ποικιλία γλωσσών και πλαισίων. Σήμερα θα ήθελα να μιλήσω για ένα τέτοιο πλαίσιο όπως NestJS. Είμαστε μέσα TestMace Το χρησιμοποιούμε ενεργά για εσωτερικά έργα. Χρήση φωλιάς και συσκευασίας @nestjsx/crud, θα δημιουργήσουμε μια απλή εφαρμογή CRUD.

Γιατί NestJS

Πρόσφατα, έχουν εμφανιστεί πολλά πλαίσια backend στην κοινότητα JavaScript. Και αν όσον αφορά τη λειτουργικότητα παρέχουν παρόμοιες δυνατότητες με το Nest, τότε σε ένα πράγμα σίγουρα κερδίζει - αυτή είναι η αρχιτεκτονική. Οι ακόλουθες δυνατότητες NestJS σάς επιτρέπουν να δημιουργείτε βιομηχανικές εφαρμογές και να κλιμακώνετε την ανάπτυξη σε μεγάλες ομάδες:

• χρησιμοποιώντας την TypeScript ως κύρια γλώσσα ανάπτυξης. Αν και το NestJS υποστηρίζει JavaScript, ορισμένες λειτουργίες ενδέχεται να μην λειτουργούν, ειδικά αν μιλάμε για πακέτα τρίτων.
• η παρουσία ενός δοχείου DI, το οποίο σας επιτρέπει να δημιουργήσετε εξαρτήματα χαλαρά συζευγμένα.
• Η λειτουργικότητα του ίδιου του πλαισίου χωρίζεται σε ανεξάρτητα εναλλάξιμα στοιχεία. Για παράδειγμα, κάτω από την κουκούλα ως πλαίσιο μπορεί να χρησιμοποιηθεί ως ρητήΚαι νηστεύω, για να εργαστείτε με τη βάση δεδομένων, το nest out of the box παρέχει συνδέσμους σε τύπος, μαγκούστα, συνέχεια;
• Το NestJS είναι αγνωστικιστής πλατφόρμας και υποστηρίζει REST, GraphQL, Websockets, gRPC κ.λπ.

Το ίδιο το πλαίσιο είναι εμπνευσμένο από το πλαίσιο του Angular frontend και εννοιολογικά έχει πολλά κοινά με αυτό.

Εγκατάσταση NestJS και ανάπτυξη του έργου

Το Nest περιέχει ένα πακέτο φωλιά/cli, το οποίο σας επιτρέπει να αναπτύξετε γρήγορα ένα βασικό πλαίσιο εφαρμογής. Ας εγκαταστήσουμε αυτό το πακέτο παγκοσμίως:

npm install --global @nest/cli

Μετά την εγκατάσταση, θα δημιουργήσουμε το βασικό πλαίσιο της εφαρμογής μας με το όνομα nest-rest. Αυτό γίνεται χρησιμοποιώντας την εντολή 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

Θα επιλέξουμε νήμα ως διαχειριστή πακέτων.
Σε αυτό το σημείο μπορείτε να ξεκινήσετε τον διακομιστή με την εντολή npm start και πηγαίνοντας στη διεύθυνση http://localhost:3000 μπορείτε να δείτε την κεντρική σελίδα. Ωστόσο, δεν είναι αυτός ο λόγος που μαζευτήκαμε εδώ και προχωράμε.

Ρύθμιση εργασίας με τη βάση δεδομένων

Επέλεξα το PostrgreSQL ως DBMS για αυτό το άρθρο. Δεν υπάρχει αμφιβολία για τα γούστα· κατά τη γνώμη μου, αυτό είναι το πιο ώριμο DBMS, με όλες τις απαραίτητες δυνατότητες. Όπως ήδη αναφέρθηκε, η Nest παρέχει ενοποίηση με διάφορα πακέτα για εργασία με βάσεις δεδομένων. Επειδή Εφόσον η επιλογή μου έπεσε στην PostgreSQL, θα ήταν λογικό να επιλέξω το TypeORM ως ORM. Ας εγκαταστήσουμε τα απαραίτητα πακέτα για ενοποίηση με τη βάση δεδομένων:

yarn add typeorm @nestjs/typeorm pg

Με τη σειρά, τι χρειάζεται κάθε πακέτο:

1. typeorm - ένα πακέτο απευθείας από το ίδιο το ORM.
2. @nestjs/typeorm - Πακέτο TypeORM για NestJS. Προσθέτει ενότητες για εισαγωγή σε ενότητες έργου, καθώς και ένα σύνολο βοηθητικών διακοσμητών.
3. pg - πρόγραμμα οδήγησης για εργασία με PostgreSQL.

Εντάξει, τα πακέτα έχουν εγκατασταθεί, τώρα πρέπει να εκκινήσετε την ίδια τη βάση δεδομένων. Για την ανάπτυξη της βάσης δεδομένων, θα χρησιμοποιήσω το docker-compose.yml με το ακόλουθο περιεχόμενο:

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

Όπως μπορείτε να δείτε, αυτό το αρχείο ρυθμίζει την εκκίνηση 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 και ο κωδικός πρόσβασης είναι παράδειγμα. Η υπόλοιπη διαμόρφωση είναι ασήμαντη, επομένως θα επικεντρωθούμε μόνο στις πιο ενδιαφέρουσες παραμέτρους:

• συγχρονισμός - Υποδεικνύει εάν το σχήμα της βάσης δεδομένων θα πρέπει να δημιουργηθεί αυτόματα κατά την εκκίνηση της εφαρμογής. Να είστε προσεκτικοί με αυτήν την επιλογή και μην τη χρησιμοποιείτε στην παραγωγή, διαφορετικά θα χάσετε δεδομένα. Αυτή η επιλογή είναι βολική κατά την ανάπτυξη και τον εντοπισμό σφαλμάτων μιας εφαρμογής. Ως εναλλακτική σε αυτήν την επιλογή, μπορείτε να χρησιμοποιήσετε την εντολή schema:sync από το CLI TypeORM.
• dropSchema - επαναφέρετε το σχήμα κάθε φορά που δημιουργείται μια σύνδεση. Όπως και η προηγούμενη, αυτή η επιλογή θα πρέπει να χρησιμοποιείται μόνο κατά την ανάπτυξη και τον εντοπισμό σφαλμάτων της εφαρμογής.
• οντότητες - ποιες διαδρομές για να αναζητήσετε περιγραφές μοντέλων. Λάβετε υπόψη ότι υποστηρίζεται η αναζήτηση με μάσκα.
• Το 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 για να εκτελέσει το cli TypeORM. Οι υπόλοιπες εντολές είναι βολικές συντομεύσεις που εσείς, ως προγραμματιστής, θα χρησιμοποιείτε σχεδόν κάθε μέρα:
migration:generate — δημιουργία μετεγκαταστάσεων με βάση τις αλλαγές στα μοντέλα σας.
migration:create — δημιουργία κενού μετανάστευσης.
migration:run — εκκίνηση μεταναστεύσεων.
Λοιπόν, αυτό είναι τώρα, προσθέσαμε τα απαραίτητα πακέτα, διαμορφώσαμε την εφαρμογή ώστε να λειτουργεί με τη βάση δεδομένων τόσο από το cli όσο και από την ίδια την εφαρμογή, και επίσης ξεκινήσαμε το DBMS. Ήρθε η ώρα να προσθέσουμε λογική στην εφαρμογή μας.

Εγκατάσταση πακέτων για τη δημιουργία CRUD

Χρησιμοποιώντας μόνο το Nest, μπορείτε να δημιουργήσετε ένα API που σας επιτρέπει να δημιουργείτε, να διαβάζετε, να ενημερώνετε και να διαγράφετε μια οντότητα. Αυτή η λύση θα είναι όσο το δυνατόν πιο ευέλικτη, αλλά σε ορισμένες περιπτώσεις θα είναι περιττή. Για παράδειγμα, εάν χρειάζεται να δημιουργήσετε γρήγορα ένα πρωτότυπο, μπορείτε συχνά να θυσιάσετε την ευελιξία για την ταχύτητα ανάπτυξης. Πολλά πλαίσια παρέχουν λειτουργικότητα για τη δημιουργία CRUD περιγράφοντας το μοντέλο δεδομένων μιας συγκεκριμένης οντότητας. Και η Nest δεν αποτελεί εξαίρεση! Αυτή η λειτουργία παρέχεται από το πακέτο @nestjsx/crud. Οι δυνατότητές του είναι πολύ ενδιαφέρουσες:

• εύκολη εγκατάσταση και διαμόρφωση.
• Ανεξαρτησία DBMS;
• ισχυρή γλώσσα ερωτημάτων με δυνατότητα φιλτραρίσματος, σελιδοποίησης, ταξινόμησης, φόρτωσης σχέσεων και ένθετων οντοτήτων, προσωρινής αποθήκευσης κ.λπ.
• πακέτο για τη δημιουργία αιτημάτων στο front-end.
• εύκολη παράκαμψη των μεθόδων ελεγκτή.
• Μικρή διαμόρφωση?
• υποστήριξη τεκμηρίωσης swagger.

Η λειτουργικότητα χωρίζεται σε διάφορα πακέτα:

• @nestjsx/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

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)

Σε αυτή την ενότητα θα προσθέσουμε έναν φάκελο οντοτήτων, όπου θα έχουμε τα μοντέλα αυτής της ενότητας. Συγκεκριμένα, ας προσθέσουμε εδώ το αρχείο 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;
}

Για να «δει» αυτό το μοντέλο από την εφαρμογή μας, είναι απαραίτητο στο module UsersModule εισαγωγή TypeOrmModule το ακόλουθο περιεχόμενο:

users.module.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
}
})

Ακατέργαστος είναι ένας διακοσμητής που προσθέτει στον ελεγκτή τις απαραίτητες μεθόδους εργασίας με το μοντέλο. Ο τύπος μοντέλου υποδεικνύεται στο πεδίο 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. αίτημα για το αναγνωριστικό του νέου χρήστη.
3. διαγραφή από το αναγνωριστικό χρήστη που δημιουργήθηκε στο βήμα 1.

Λοιπόν πάμε. Για ευκολία, ας δημιουργήσουμε έναν κόμβο σαν Folder. Ουσιαστικά, αυτός είναι απλώς ένας φάκελος στον οποίο θα αποθηκεύσουμε ολόκληρο το σενάριο. Για να δημιουργήσετε έναν κόμβο φακέλου, επιλέξτε Έργο από το μενού περιβάλλοντος του κόμβου Προσθήκη κόμβου -> Φάκελος. Ας καλέσουμε τον κόμβο έλεγχος-δημιουργία. Μέσα σε έναν κόμβο έλεγχος-δημιουργία Ας δημιουργήσουμε το πρώτο μας αίτημα για δημιουργία χρήστη. Ας καλέσουμε τον κόμβο που δημιουργήθηκε πρόσφατα δημιουργία-χρήστη. Δηλαδή, αυτή τη στιγμή η ιεραρχία των κόμβων θα μοιάζει με αυτό:

Ας πάμε στην ανοιχτή καρτέλα δημιουργία-χρήστη κόμβος. Ας εισαγάγουμε τις ακόλουθες παραμέτρους για το αίτημα:

• Τύπος αιτήματος - POST
• URL - localhost:3000/χρήστες
• Σώμα - JSON με αξία {"email": "[email protected]", "displayName": "New user", "username": "user"}

Ας εκπληρώσουμε αυτό το αίτημα. Η εφαρμογή μας λέει ότι η εγγραφή έχει δημιουργηθεί.

Λοιπόν, ας ελέγξουμε αυτό το γεγονός. Για να λειτουργήσετε με το αναγνωριστικό του χρήστη που δημιουργήθηκε στα επόμενα βήματα, αυτή η παράμετρος πρέπει να αποθηκευτεί. Ο μηχανισμός είναι τέλειος για αυτό. δυναμικές μεταβλητές. Ας χρησιμοποιήσουμε το παράδειγμά μας για να δούμε πώς να δουλέψουμε μαζί τους. Στην καρτέλα ανάλυσης της απάντησης, δίπλα στον κόμβο αναγνωριστικού στο μενού περιβάλλοντος, επιλέξτε το στοιχείο Αντιστοίχιση σε μεταβλητή. Στο παράθυρο διαλόγου πρέπει να ορίσετε τις ακόλουθες παραμέτρους:

• Κόμβος — σε ποιον από τους προγόνους να δημιουργήσει μια δυναμική μεταβλητή. Ας διαλέξουμε έλεγχος-δημιουργία
• Όνομα μεταβλητής — το όνομα αυτής της μεταβλητής. Ας καλέσουμε userId.

Δείτε πώς φαίνεται η διαδικασία δημιουργίας μιας δυναμικής μεταβλητής:

Τώρα, κάθε φορά που εκτελείται αυτό το ερώτημα, η τιμή της δυναμικής μεταβλητής θα ενημερώνεται. Και επειδή Οι δυναμικές μεταβλητές υποστηρίζουν τον μηχανισμό της ιεραρχικής κληρονομικότητας, μεταβλητή userId θα είναι διαθέσιμο σε απογόνους έλεγχος-δημιουργία κόμβος οποιουδήποτε επιπέδου ένθεσης.
Αυτή η μεταβλητή θα μας είναι χρήσιμη στο επόμενο αίτημα. Δηλαδή, θα ζητήσουμε τον νέο χρήστη. Ως παιδί ενός κόμβου έλεγχος-δημιουργία θα δημιουργήσουμε ένα αίτημα έλεγχος εάν υπάρχει με παράμετρο url ίσος localhost:3000/users/${$dynamicVar.userId}. Προβολή σχεδίου ${variable_name} αυτό παίρνει την τιμή μιας μεταβλητής. Επειδή Έχουμε μια δυναμική μεταβλητή, οπότε για να την αποκτήσετε πρέπει να έχετε πρόσβαση στο αντικείμενο $dynamicVar, δηλαδή πλήρης πρόσβαση σε μια δυναμική μεταβλητή userId θα μοιάζει με αυτό ${$dynamicVar.userId}. Ας εκτελέσουμε το αίτημα και βεβαιωθούμε ότι τα δεδομένα έχουν ζητηθεί σωστά.
Το τελευταίο βήμα που απομένει είναι να ζητήσετε διαγραφή. Το χρειαζόμαστε όχι μόνο για να ελέγξουμε τη λειτουργία της διαγραφής, αλλά και, ας πούμε, για να καθαρίσουμε τον εαυτό μας στη βάση δεδομένων, επειδή Τα πεδία email και ονόματος χρήστη είναι μοναδικά. Έτσι, στον κόμβο check-create θα δημιουργήσουμε ένα αίτημα διαγραφής χρήστη με τις ακόλουθες παραμέτρους

• Τύπος αιτήματος - ΔΙΑΓΡΑΦΗ
• URL - localhost:3000/users/${$dynamicVar.userId}

Ας ξεκινήσουμε. Περιμένουμε. Απολαμβάνουμε το αποτέλεσμα)

Λοιπόν, τώρα μπορούμε να εκτελέσουμε ολόκληρο το σενάριο ανά πάσα στιγμή. Για να εκτελέσετε το σενάριο πρέπει να επιλέξετε από το μενού περιβάλλοντος έλεγχος-δημιουργία στοιχείο κόμβου τρέξιμο.

Οι κόμβοι στο σενάριο θα εκτελούνται ο ένας μετά τον άλλο
Μπορείτε να αποθηκεύσετε αυτό το σενάριο στο έργο σας εκτελώντας Αρχείο -> Αποθήκευση έργου.

Συμπέρασμα

Όλα τα χαρακτηριστικά των εργαλείων που χρησιμοποιήθηκαν απλά δεν μπορούσαν να χωρέσουν στη μορφή αυτού του άρθρου. Όσο για τον κύριο ένοχο - το πακέτο φωλιάjsx/crud - τα ακόλουθα θέματα παραμένουν ακάλυπτα:

• προσαρμοσμένη επικύρωση και μετατροπή μοντέλων·
• ισχυρή γλώσσα ερωτημάτων και η άνετη χρήση της στο μπροστινό μέρος.
• επαναπροσδιορισμός και προσθήκη νέων μεθόδων στους ελεγκτές αργού.
• swagger υποστήριξη?
• διαχείριση προσωρινής αποθήκευσης.

Ωστόσο, ακόμη και αυτά που περιγράφονται στο άρθρο είναι αρκετά για να καταλάβουμε ότι ακόμη και ένα τέτοιο εταιρικό πλαίσιο όπως το NestJS διαθέτει εργαλεία για γρήγορη δημιουργία πρωτοτύπων εφαρμογών. Και ένα τόσο ωραίο IDE like TestMace σας επιτρέπει να διατηρήσετε έναν δεδομένο ρυθμό.

Πηγαίος κώδικας για αυτό το άρθρο, μαζί με το έργο TestMace, διαθέσιμο στο αποθετήριο https://github.com/TestMace/nest-rest. Για να ανοίξετε ένα έργο TestMace απλά κάντε το στην εφαρμογή Αρχείο -> Άνοιγμα έργου.

Πηγή: www.habr.com