Obecnie REST API stało się standardem w tworzeniu aplikacji internetowych, umożliwiając podział procesu rozwoju na niezależne komponenty. W przypadku UI najczęściej korzysta się z popularnych frameworków takich jak Angular, React, Vue i innych. Deweloperzy backend mogą wybierać z szerokiego asortymentu języków i frameworków. Dziś chciałbym porozmawiać o frameworku takim jak . W aktywnie go wykorzystujemy w naszych projektach. Używając nest i pakietu , stworzymy prostą aplikację CRUD.
Dlaczego NestJS
W ostatnich latach w społeczności JavaScript pojawiło się wiele frameworków backendowych. Choć pod względem funkcjonalności oferują podobne możliwości jak Nest, to w jednej rzeczy jednoznacznie wygrywa — w architekturze. Następujące cechy NestJS pozwalają na tworzenie aplikacji przemysłowych i skalowanie w dużych zespołach:
- użycie TypeScript jako głównego języka programowania. Chociaż NestJS wspiera JavaScript, część funkcjonalności może nie działać, szczególnie jeśli chodzi o zewnętrzne pakiety;
- obecność kontenera DI, co pozwala na tworzenie luźno powiązanych komponentów;
- funkcjonalność samego frameworka jest podzielona na niezależne, wymienne komponenty. Na przykład, pod maską jako framework może być używany zarówno , jak i , do pracy z bazą danych nest zapewnia natychmiastowe powiązania z , , ;
- NestJS jest niezależny od platformy i obsługuje REST, GraphQL, Websockets, gRPC itd.
Sam framework jest inspirowany frameworkiem frontendowym Angular i koncepcyjnie ma wiele wspólnego z nim.
Instalacja NestJS i uruchomienie projektu
Nest zawiera pakiet /cli, который позволяет быстро развернуть базовый каркас приложения. Установим глобально данный пакет:
npm install --global @nest/cliPo zainstalowaniu wygenerujemy bazowy szkielet naszej aplikacji o nazwie nest-rest. Robi się to przy użyciu polecenia nest new nest-rest.
nest new nest-rest
dmitrii@dmitrii-HP-ZBook-17-G3:~/projects $ nest new nest-rest
Szybko rozpoczniemy tworzenie aplikacji..
CREATE /nest-rest/.prettierrc (51 bajtów)
CREATE /nest-rest/README.md (3370 bajtów)
CREATE /nest-rest/nest-cli.json (84 bajty)
CREATE /nest-rest/nodemon-debug.json (163 bajty)
CREATE /nest-rest/nodemon.json (67 bajtów)
CREATE /nest-rest/package.json (1805 bajtów)
CREATE /nest-rest/tsconfig.build.json (97 bajtów)
CREATE /nest-rest/tsconfig.json (325 bajtów)
CREATE /nest-rest/tslint.json (426 bajtów)
CREATE /nest-rest/src/app.controller.spec.ts (617 bajtów)
CREATE /nest-rest/src/app.controller.ts (274 bajty)
CREATE /nest-rest/src/app.module.ts (249 bajtów)
CREATE /nest-rest/src/app.service.ts (142 bajtów)
CREATE /nest-rest/src/main.ts (208 bajtów)
CREATE /nest-rest/test/app.e2e-spec.ts (561 bajtów)
CREATE /nest-rest/test/jest-e2e.json (183 bajtów)
? Którego menedżera pakietów chciałbyś użyć? yarn
Instalacja w toku...
Sukces: utworzono projekt nest-rest
Zacznij korzystać z poniższych poleceń:
$ cd nest-rest
$ yarn run start
Dziękujemy za instalację Nest
Proszę rozważyć darowiznę na nasze otwarte zbiory
aby pomóc nam utrzymać ten pakiet.
Wsparcie: https://opencollective.com/nestJako menedżer pakietów wybierzemy yarn.
Aktualnie możesz uruchomić serwer poleceniem npm start i przejść pod adres możesz zobaczyć stronę główną. Jednak nie po to tu jesteśmy, więc idźmy dalej.
Konfigurujemy połączenie z bazą danych
Jako system baz danych w tym artykule wybrałem PostgreSQL. O gustach się nie dyskutuje, moim zdaniem jest to najbardziej dojrzały system baz danych, który ma wszystkie niezbędne funkcje. Jak już wspomniano, do zarządzania bazami danych Nest oferuje integrację z różnymi pakietami. Ponieważ zdecydowałem się na PostgreSQL, logicznym wyborem będzie TypeORM jako ORM. Zainstalujmy niezbędne pakiety do integracji z bazą danych:
yarn add typeorm @nestjs/typeorm pg
W kolejności, do czego służy każdy pakiet:
- typeorm — pakiet związany z samą ORM;
- @nestjs/typeorm — pakiet TypeORM dla NestJS. Dodaje moduły do importowania w modułach projektu oraz zestaw dekoratorów-pomocników;
- pg — sterownik do pracy z PostgreSQL.
OK, pakiety są zainstalowane, teraz trzeba uruchomić bazę danych. Do wdrożenia bazy będę używał pliku docker-compose.yml o następującej treści:
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:8080Jak widać, ten plik konfiguruje uruchomienie 2 kontenerów:
- db — to kontener zawierający bezpośrednio bazę danych. W naszym przypadku używamy postgresql w wersji 11.2;
- adminer — menedżer bazy danych. Oferuje interfejs webowy do przeglądania i zarządzania bazą.
Aby skonfigurować połączenia TCP, dodałem plik konfiguracyjny o następującej treści.
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 hereNa tym kończymy, możemy uruchomić kontenery komendą docker-compose up -d. Lub w osobnej konsoli przy pomocy komendy docker-compose up.
Zainstalowaliśmy pakiety, uruchomiliśmy bazę danych, teraz musimy je ze sobą połączyć. W tym celu należy dodać do głównego katalogu projektu plik ormconfig.js o następującej treści:
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"
}
}
Ta konfiguracja będzie używana dla CLI typeorm.
Przyjrzyjmy się tej konfiguracji bliżej. W wierszach 3 i 4 pobieramy nazwę użytkownika i hasło z zmiennych środowiskowych. To wygodne, gdy masz kilka środowisk (dev, stage, prod itd.). Domyślnie nazwa użytkownika to postgres, a hasło to example. Pozostała część konfiguracji jest trywialna, dlatego skupimy się tylko na najciekawszych parametrach:
- synchronize — wskazuje, czy schemat bazy danych ma być automatycznie tworzony podczas uruchamiania aplikacji. Uważaj na tę opcję i nie używaj jej w środowisku produkcyjnym, w przeciwnym razie możesz stracić dane. Ta opcja jest wygodna podczas rozwoju i debugowania aplikacji. Jako alternatywę dla tej opcji możesz użyć polecenia
schema:syncz CLI TypeORM. - dropSchema — resetuje schemat za każdym razem, gdy nawiązywane jest połączenie. Podobnie jak w przypadku poprzedniej opcji, tę opcję należy stosować tylko podczas procesu rozwoju i debugowania aplikacji.
- entities — ścieżki, gdzie szukać opisu modeli. Zwróć uwagę, że wspierane jest wyszukiwanie za pomocą maski.
- cli.entitiesDir — katalog, w którym domyślnie powinny znajdować się modele tworzone z CLI TypeORM.
Abyśmy mogli wykorzystać wszystkie możliwości TypeORM w naszej aplikacji Nest, należy zaimportować moduł TypeOrmModule w AppModule. To znaczy, że Twój AppModule będzie wyglądał następująco:
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 {}Jak zauważyłeś, w metodzie forRoot przekazywana jest ta sama konfiguracja do pracy z bazą, co w pliku ormconfig.ts
Został ostatni szlif — dodanie kilku zadań do pracy z TypeORM w package.json. Rzecz w tym, że CLI jest napisane w JavaScript i uruchamiane w środowisku nodejs. Jednak wszystkie nasze modele i migracje będą napisane w TypeScript. Dlatego konieczne jest przetłumaczenie naszych migracji i modeli przed użyciem CLI. W tym celu potrzebujemy paczki ts-node:
yarn add -D ts-node
Następnie dodamy niezbędne komendy do 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"Pierwsza komenda, typeorm, dodaje owijanie przy użyciu ts-node do uruchamiania cli TypeORM. Pozostałe komendy to wygodne skróty, z których jako deweloper będziesz korzystać praktycznie codziennie:
migration:generate — tworzenie migracji na podstawie zmian w twoich modelach.
migration:create — tworzenie pustej migracji.
migration:run — uruchamianie migracji.
No to teraz już wszystko, dodaliśmy niezbędne pakiety, skonfigurowaliśmy aplikację do pracy z bazą danych zarówno przez cli, jak i z samej aplikacji, a także uruchomiliśmy system zarządzania bazą danych. Czas dodać logikę do naszej aplikacji.
Instalacja pakietów do tworzenia CRUD
Używając tylko Nest, można stworzyć API, które pozwala na tworzenie, odczytywanie, aktualizowanie i usuwanie encji. Takie rozwiązanie będzie maksymalnie elastyczne, jednak w niektórych przypadkach może być nadmiarowe. Na przykład, jeśli potrzebujesz szybko stworzyć prototyp, często można poświęcić elastyczność na rzecz szybkości rozwoju. Wiele frameworków oferuje funkcjonalność generowania CRUD w oparciu o opis modelu danych konkretnej encji. I Nest nie jest wyjątkiem! Tę funkcjonalność oferuje pakiet . Jego możliwości są bardzo interesujące:
- łatwa instalacja i konfiguracja;
- niezależność od DBMS;
- potężny język zapytań z możliwością filtrowania, paginacji, sortowania, ładowania relacji i zagnieżdżonych encji, buforowania itp.;
- pakiet do tworzenia zapytań po stronie front-end;
- łatwe nadpisywanie metod kontrolera;
- mała konfiguracja;
- wsparcie dla dokumentacji swagger.
Funkcjonalności są podzielone na kilka pakietów:
- — podstawowy pakiet, który oferuje dekorator () do generowania tras, konfiguracji i walidacji;
- — pakiet, który zapewnia builder/parser zapytań do użycia po stronie frontend;
- — pakiet do integracji z TypeORM, który zapewnia podstawową usługę TypeOrmCrudService z metodami CRUD do pracy z encjami w bazie danych.
W tym przewodniku będziemy potrzebować pakietów jsx/crud oraz jsx/crud-typeorm. Na początek zainstalujemy je
yarn add @nestjsx/crud class-transformer class-validatorPakiety и są wymagane w tej aplikacji do deklaratywnego opisu zasad transformacji instancji modeli oraz walidacji przychodzących zapytań. Te pakiety pochodzą od jednego autora, dlatego interfejsy są podobne.
Bezpośrednia realizacja CRUD
Jako przykład modelu weźmiemy listę użytkowników. Użytkownicy będą mieli następujące pola: id, username, displayName, email. id — pole autoinkrementacyjne, email и username — unikalne pola. To proste! Pozostaje nam zrealizować naszą koncepcję w postaci aplikacji Nest.
Na początek trzeba stworzyć moduł users, który będzie odpowiedzialny za pracę z użytkownikami. Skorzystamy z CLI od NestJS i w głównym katalogu naszego projektu wykonamy polecenie nest g module users.
nest g module users
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)W tym module dodamy folder entities, w którym będą przechowywane modele tego modułu. W szczególności dodamy tutaj plik user.entity.ts z opisem modelu użytkowników:
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;
}Aby nasza aplikacja „widziała” ten model, należy w module UsersModule zaimportować TypeOrmModule o następującej treści:
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 {}Czyli tutaj importujemy TypeOrmModule, gdzie jako parametr metody forFeature określamy listę modeli związanych z tym modułem.
Pozostaje stworzyć odpowiednią encję w bazie danych. W tym celu służy mechanizm migracji. Aby stworzyć migrację na podstawie zmian w modelach, należy wykonać komendę npm run migration:generate -- CreateUserTable:
Nagłówek spoilera
$ npm run migration:generate -- CreateUserTable
Migracja /home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts została pomyślnie wygenerowana.
Zakończono w 1,96s.Nie musieliśmy pisać migracji ręcznie, wszystko wydarzyło się w magiczny sposób. Czy to nie cud! Ale to jeszcze nie wszystko. Spójrzmy na utworzony plik migracji:
1563346135367-CreateUserTable.ts
import {MigrationInterface, QueryRunner} from "typeorm";
export class CreateUserTable1563346816726 implements MigrationInterface {
public async up(queryRunner: QueryRunner): Promise {
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 {
await queryRunner.query(`DROP TABLE "user"`);
}
}Jak można zauważyć, został automatycznie wygenerowany nie tylko metod do uruchomienia migracji, ale także metod do jej cofnięcia. Fantastyczne!
Pozostaje tylko zastosować tę migrację. Robi się to następującą komendą:
npm run migration:run.Wszystko, teraz zmiany w schemacie trafiły do bazy danych.
Następnie stworzymy serwis, który będzie odpowiedzialny za pracę z użytkownikami i odziedziczymy go po TypeOrmCrudService. W parametrze nadrzędnego konstruktora należy przekazać repozytorium interesującego obiektu, w naszym przypadku Użytkownik repozytorium.
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{
constructor(@InjectRepository(User) usersRepository: Repository){
super(usersRepository);
}
}Ten serwis będzie potrzebny w kontrolerze users. Aby stworzyć kontroler, wpisz w konsoli nest g controller users/controllers/users
nest g controller users/controllers/users
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)Otwórzmy ten kontroler i edytujmy go, aby dodać odrobinę magii jsx/crud. Do klasy UsersController dodamy dekorator w następujący sposób:
@Crud({
model: {
type: User
}
}) — jest to dekorator, który dodaje do kontrolera niezbędne metody do pracy z modelem. Typ modelu wskazany jest w polu model.type konfiguracji dekoratora.
Drugi krok — należy zaimplementować interfejs CrudController. W całości kod kontrolera wygląda następująco:
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{
constructor(public service: UsersService){}
}I to wszystko! Teraz kontroler obsługuje pełen zestaw operacji z modelem! Nie wierzysz? Spróbujmy uruchomić naszą aplikację!
Tworzenie skryptów zapytań w TestMace
Do testowania naszego serwisu użyjemy IDE do pracy z API. . Dlaczego TestMace? W porównaniu z podobnymi produktami ma następujące zalety:
- potężne operacje na zmiennych. Obecnie istnieje kilka typów zmiennych, z których każdy pełni określoną rolę: zmienne wbudowane, zmienne dynamiczne, zmienne środowiskowe. Każda zmienna należy do określonego węzła wspierającego mechanizm dziedziczenia;
- łatwe tworzenie skryptów bez programowania. O tym będzie mowa poniżej;
- czytelny format, który pozwala na przechowywanie projektu w systemach kontroli wersji;
- automatyczne uzupełnianie, podświetlanie składni, podświetlanie wartości zmiennych;
- wsparcie dla opisu API z możliwością importu z Swagger.
Uruchommy nasz serwer komendą npm start i spróbujmy uzyskać dostęp do listy użytkowników. Listę użytkowników, zgodnie z naszą konfiguracją kontrolera, można otrzymać pod adresem url localhost:3000/users. Wykonajmy zapytanie do tego url.
Po uruchomieniu TestMace możesz zobaczyć taki interfejs:
W lewym górnym rogu znajduje się drzewo projektów z węzłem głównym . Spróbujmy stworzyć nasze pierwsze zapytanie o listę użytkowników. W tym celu utworzymy węzeł. Robimy to w menu kontekstowym węzła Project Dodaj węzeł -> RequestStep.
W polu URL wstaw localhost:3000/users i wykonaj zapytanie. Otrzymamy kod 200 z pustą tablicą w treści odpowiedzi. Nic dziwnego, jeszcze nikogo nie dodaliśmy.
Stwórzmy scenariusz, który będzie zawierał następujące kroki:
- stworzenie użytkownika;
- zapytanie po id właśnie utworzonego użytkownika;
- usunięcie po id użytkownika utworzonego w kroku 1.
Zatem, zaczynajmy. Dla wygody utworzymy węzeł typu . W zasadzie to po prostu folder, w którym zapiszemy cały scenariusz. Aby utworzyć węzeł Folder, należy w menu kontekstowym węzła Project wybrać Dodaj węzeł -> Folder. Nazwijmy węzeł check-create. Wewnątrz węzła check-create stworzymy nasze pierwsze zapytanie do utworzenia użytkownika. Nazwiemy nowo utworzony węzeł create-user. To znaczy, na ten moment hierarchia węzłów będzie wyglądać następująco:
Przejdźmy do zakładki otwartego create-user węzła. Wprowadźmy następujące parametry dla zapytania:
- Typ zapytania — POST
- URL — localhost:3000/users
- Body — JSON z wartością
{"email": "user@user.com", "displayName": "Nowy użytkownik", "username": "user"}
Wykonamy to zapytanie. Nasza aplikacja informuje, że rekord został utworzony.
Cóż, sprawdźmy ten fakt. Aby w następnych krokach operować z id utworzonego użytkownika, ten parametr należy zachować. Świetnie nadaje się do tego mechanizm . Przyjrzyjmy się na naszym przykładzie, jak działa z nimi współpraca. W zakładce parsed odpowiedzi węzła id w menu kontekstowym należy wybrać opcję Przypisz do zmiennej. W oknie dialogowym należy ustawić następujące parametry:
- Węzeł — w którym z przodków utworzyć zmienną dynamiczną. Wybierzemy check-create
- Nazwa zmiennej — nazwa tej zmiennej. Nazwiemy
userId.
Oto jak wygląda proces tworzenia zmiennej dynamicznej:
Teraz przy każdym wykonaniu tego zapytania wartość zmiennej dynamicznej będzie aktualizowana. A ponieważ dynamiczne zmienne wspierają mechanizm dziedziczenia hierarchicznego, zmienna userId będzie dostępna w potomkach check-create węzła na każdym poziomie zagnieżdżenia.
W następnym zapytaniu ta zmienna będzie nam potrzebna. A mianowicie, zapytamy o nowo utworzonego użytkownika. Jako potomek węzła check-create stworzysz zapytanie check-if exists z parametrem url równym localhost:3000/users/${$dynamicVar.userId}. Konstrukcja typu ${variable_name} to uzyskiwanie wartości zmiennej. Ponieważ mamy zmienną dynamiczną, aby ją uzyskać, należy odwołać się do obiektu $dynamicVar, tzn. całkowite odwołanie do zmiennej dynamicznej userId będzie wyglądać następująco ${$dynamicVar.userId}. Wykonaj zapytanie i upewnij się, że dane są poprawnie pobierane.
Pozostał ostatni akcent — złożyć zapytanie o usunięcie. Potrzebujemy go nie tylko do sprawdzenia działania usuwania, ale także, że tak powiem, posprzątać po sobie w bazie, ponieważ pola email i username są unikalne. Tak więc w węźle check-create stwórz zapytanie delete-user z następującymi parametrami
- Typ zapytania — DELETE
- URL —
localhost:3000/users/${$dynamicVar.userId}
Uruchamiamy. Czekamy. Cieszymy się wynikiem)
A teraz możemy w każdej chwili uruchomić ten skrypt w całości. Aby uruchomić skrypt, należy wybrać z menu kontekstowego check-create węzła punkt Uruchom.
Węzły w skrypcie będą wykonywane pojedynczo
Ten skrypt możesz zapisać w swoim projekcie, wykonując Plik -> Zapisz projekt.
Podsumowanie
W formacie tego artykułu nie udało się pomieścić wszystkich funkcji użytych narzędzi. Jeśli chodzi o głównego sprawcę — pakiet jsx/crud — nierozwiązane tematy to:
- niestandardowa walidacja i transformacja modeli;
- potężny język zapytań i wygodne jego użycie na froncie;
- nadpisywanie i dodawanie nowych metod w kontrolerach crud;
- wsparcie swagger;
- zarządzanie pamięcią podręczną.
Jednak opisana w artykule zawartość wystarczy, aby zrozumieć, że nawet taki korporacyjny framework jak NestJS ma w zanadrzu narzędzia do szybkiego prototypowania aplikacji. A takie świetne IDE jak pozwala utrzymać określony rytm.
Kod źródłowy tego artykułu, wraz z projektem , dostępny jest w repozytorium . Aby otworzyć projekt wystarczy w aplikacji wykonać Plik -> Otwórz projekt.
Źródło: habr.com
