A REST API has now become the standard for web application development, allowing the development to be broken down into independent parts. For the UI, various popular frameworks like Angular, React, Vue, and others are currently used. Backend developers can choose from a wide variety of languages and frameworks. Today I would like to discuss a framework called . We at actively use it for internal projects. Using nest and the package , we will create a simple CRUD application.
Why NestJS
Recently, there have been quite a few backend frameworks emerging in the JavaScript community. While they offer similar functionalities to Nest, one area where it definitely excels is architecture. The following features of NestJS allow for the creation of industrial applications and scaling development to large teams:
- using TypeScript as the primary development language. Although NestJS supports JavaScript, some functionalities may not work, especially when it comes to third-party packages;
- the presence of a DI container, which allows for the creation of loosely coupled components;
- the framework's functionality is divided into independent, interchangeable components. For example, under the hood, it can use , valamint , and for database work, Nest provides bindings to , , ;
- NestJS is platform-independent and supports REST, GraphQL, Websockets, gRPC, etc.
The framework itself is inspired by the frontend framework Angular and has many conceptual similarities with it.
Installing NestJS and deploying the project
Nest includes the package /cli, который позволяет быстро развернуть базовый каркас приложения. Установим глобально данный пакет:
npm install --global @nest/cliAfter installation, we will generate the basic structure of our application named nest-res. This is done using the command nest new nest-rest.
nest new nest-rest
dmitrii@dmitrii-HP-ZBook-17-G3:~\/projects $ nest new nest-rest
Az alkalmazásod néhány másodperc alatt fel lesz építve..
CREATE \/nest-rest\/ .prettierrc (51 bájt)
CREATE \/nest-rest\/README.md (3370 bájt)
CREATE \/nest-rest\/nest-cli.json (84 bájt)
CREATE \/nest-rest\/nodemon-debug.json (163 bájt)
CREATE \/nest-rest\/nodemon.json (67 bájt)
CREATE \/nest-rest\/package.json (1805 bájt)
CREATE \/nest-rest\/tsconfig.build.json (97 bájt)
CREATE \/nest-rest\/tsconfig.json (325 bájt)
CREATE \/nest-rest\/tslint.json (426 bájt)
CREATE \/nest-rest\/src\/app.controller.spec.ts (617 bájt)
CREATE \/nest-rest\/src\/app.controller.ts (274 bájt)
CREATE \/nest-rest\/src\/app.module.ts (249 bájt)
CREATE \/nest-rest\/src\/app.service.ts (142 bájt)
CREATE \/nest-rest\/src\/main.ts (208 bájt)
CREATE \/nest-rest\/test\/app.e2e-spec.ts (561 bájt)
CREATE \/nest-rest\/test\/jest-e2e.json (183 bájt)
? Melyik csomagkezelőt szeretnéd használni? yarn
Telepítés folyamatban...
Sikeresen létrehoztuk a nest-rest projektet
Az alábbi parancsokkal kezdhetsz:
$ cd nest-rest
$ yarn run start
Köszönjük, hogy telepítetted a Nest-et
Kérlek, fontold meg, hogy adományozol az open collective-nek
hogy segíts nekünk fenntartani ezt a csomagot.
Adományozás: https:\/\/opencollective.com\/nestAcsomagkezelőként a yarn-t választjuk.
Jelenleg elindíthatod a szervert a következő paranccsal npm start és a címre navigálva megtekintheted a főoldalt. Azonban nem ezért vagyunk itt, haladjunk tovább.
Konfiguráljuk az adatbázis működését
Ebben a cikkben az adatbázis-kezelőként a PostgreSQL-t választottam. Az ízlés kérdése, de véleményem szerint ez a legérettebb adatbázis-kezelő, amely minden szükséges funkcióval rendelkezik. Ahogy korábban említettem, a Nest különböző csomagokkal biztosít integrációt az adatbázisokkal. Mivel a PostgreSQL-t választottam, logikus módon a TypeORM-ot választom ORM-ként. Telepítsük a szükséges csomagokat az adatbázissal való integrációhoz:
yarn add typeorm @nestjs\/typeorm pg
Részletesen, mire szolgál minden csomag:
- typeorm — a csomag magát az ORM-et tartalmazza;
- @nestjs\/typeorm — a TypeORM csomag a NestJS-hez. Modulokat ad hozzá a projekt moduljaiba való importáláshoz, valamint egy sor segéd dekorátort;
- pg — a PostgreSQL-lel való munkához szükséges meghajtó.
Rendben, a csomagok telepítve vannak, most el kell indítani magát az adatbázist. Az adatbázis telepítéséhez a következő docker-compose.yml tartalmat fogom használni:
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:8080Ahogy látod, ez a fájl két konténer indítását konfigurálja:
- db — ez a konténer magával az adatbázissal foglalkozik. Jelen esetben a 11.2-es verziójú PostgreSQL-t használjuk;
- adminer — adatbázis-kezelő. Webes felületet biztosít az adatbázis megtekintéséhez és kezeléséhez.
A TCP kapcsolatok kezeléséhez a következő tartalmú konfigurációt adtam hozzá.
, hogy a tesztadatbázisunk ne akarjon csendesen biztosítékot létrehozni.
# -----------------------------
# 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 hereEzzel végeztünk, indíthatjuk a konténereket a következő paranccsal docker-compose up -d. Vagy egy külön terminálban a következő paranccsal docker-compose up.
Tehát, telepítettük a csomagokat, elindítottuk az adatbázist, most már össze kell kapcsolnunk őket. Ehhez a projekt gyökerébe hozzá kell adni egy ormconfig.js nevű fájlt a következő tartalommal:
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"
}
}
Ez a konfiguráció a CLI TypeORM számára lesz használva.
Térjünk vissza ehhez a konfigurációhoz részletesebben. A 3. és 4. sorokban a felhasználónevet és a jelszót környezeti változókból nyerjük ki. Ez kényelmes, ha több környezet (fejlesztés, tesztelés, éles) van. Alapértelmezett felhasználónév a postgres, a jelszó pedig az example. A többi beállítás triviális, ezért csak a legérdekesebb paraméterekre fogunk koncentrálni:
- synchronize — meghatározza, hogy az adatbázis séma automatikusan létrejöjjön-e az alkalmazás indításakor. Legyen óvatos ezzel az opcióval, és ne használja éles környezetben, különben adatokat veszíthet. Ez az opció hasznos a fejlesztés és a hibaelhárítás során. Alternatívaként használhatja a parancsot
schema:synca CLI TypeORM-ból. - dropSchema — minden alkalommal visszaállítja a sémát, amikor a kapcsolat létrejön. Ezt az opciót is csak a fejlesztési és hibaelhárítási fázis során érdemes használni.
- entities — a modellek leírásának keresési útvonalai. Vegye figyelembe, hogy a maszkok szerinti keresést is támogatja.
- cli.entitiesDir — az a könyvtár, ahova alapértelmezetten a CLI TypeORM által létrehozott modellek kerülnek.
Ahhoz, hogy kihasználhassuk a TypeORM összes lehetőségét a Nest alkalmazásunkban, importálnunk kell a TypeOrmModule be. AppModule. Tehát a te AppModule a következőképpen fog kinézni:
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 {}Ahogy észrevette, a metódus forRoot a konfiguráció kerül átadásra, amely a database használatához szükséges, mint az ormconfig.ts fájlban.
Maradt egy utolsó simítás — hozzá kell adnunk néhány feladatot a TypeORM használatára a package.json fájlban. Az a helyzet, hogy a CLI JavaScript-ben van megírva és a Node.js környezetben fut. Azonban az összes modellek és migrációk TypeScript-ben készülnek. Így szükség van a migrációink és modelljeink transzpilálására a CLI használata előtt. Ehhez a ts-node csomagra lesz szükség:
yarn add -D ts-node
Ezután adjuk hozzá a szükséges parancsokat a package.json-hoz:
"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"Az első parancs, a typeorm, egy ts-node borítót ad a TypeORM CLI indításához. A többi parancs pedig kényelmes rövidítések, amelyeket fejlesztőként gyakorlatilag minden nap használni fog:
migration:generate — migráció létrehozása a modelljeidben végrehajtott változások alapján.
migration:create — üres migráció létrehozása.
migration:run — migrációk futtatása.
Most már valóban minden készen van, hozzáadtuk a szükséges csomagokat, konfiguráltuk az alkalmazást, hogy a CLI-n és az alkalmazásból egyaránt működjön a database, valamint elindítottuk az adatbázis-kezelőt. Itt az idő, hogy logikát adjunk az alkalmazásunkhoz.
Csomagok telepítése a CRUD létrehozásához
Csak a Nest használatával létrehozhatunk egy API-t, amely lehetővé teszi egy entitás létrehozását, olvasását, frissítését és törlését. Ez a megoldás a lehető legnagyobb rugalmasságot biztosít, azonban bizonyos esetekben túlságosan bonyolult lehet. Például, ha gyorsan szeretne prototípust létrehozni, gyakran feláldozhatja a rugalmasságot a fejlesztési sebesség érdekében. Sok keretrendszer kínál CRUD generálási funkciót egy adott entitás adatmodelljének leírása alapján. A Nest sem kivétel! Ezt a funkcionalitást a csomag biztosítja. Lehetőségei meglehetősen érdekesek:
- könnyű telepítés és konfigurálás;
- függetlenség az adatbázis-kezelőtől;
- erőteljes lekérdezési nyelv szűrés, lapozás, rendezés, kapcsolatok és beágyazott entitások betöltésének lehetőségével, gyorsítótárazás stb.;
- csomag a front-end lekérdezések létrehozásához;
- könnyű vezérlőmódszerek felülírása;
- kicsi konfiguráció;
- swagger dokumentáció támogatás.
A funkcionális részek több csomagra vannak bontva:
- — alapcsomag, amely dekorátort biztosít () útvonalak generálásához, konfigurálásához és validálásához;
- — csomag, amely lekérdezésépítőt/elemzőt biztosít a frontendent használatra;
- — csomag a TypeORM integrálásához, amely alap TypeOrmCrudService szolgáltatást biztosít CRUD módszerekkel az entitások kezelésére az adatbázisban.
A jelen útmutatóhoz szükségünk lesz a következő csomagokra: jsx/crud és jsx/crud-typeorm. Először telepítsük őket
yarn add @nestjsx/crud class-transformer class-validatorCsomagok és e kettő az alkalmazásban szükséges a modellek példányainak átalakítási szabályainak deklaratív leírásához és a bejövő lekérdezések validálásához. Ezek a csomagok egy szerzőtől származnak, ezért a felületek hasonlóak.
Közvetlen CRUD megvalósítás
Példaként vegyünk egy felhasználói listát modellnek. A felhasználóknak a következő mezőik lesznek: id, username, displayName, email. id — auto-increment mező, email és username — egyedi mezők. Minden egyszerű! Most megvalósítjuk az elképzelésünket egy Nest alkalmazás formájában.
Először létre kell hozni egy modult Miután megállapítottuk, hogy ki küldte a kérést, meg kell határoznunk, hogy az adott alanynak mit engedélyeztek. Egyes szolgáltatásrácsok lehetővé teszik alapvető irányelvek (arról, hogy ki mit tehet) megadását YAML-fájlok formájában vagy parancssoron, míg mások integrációt kínálnak olyan keretrendszerekkel, mint az, amely a felhasználók kezeléséért felelős. Használjuk a NestJS cli-t, és a projektünk gyökérkönyvtárában futtassuk a következő parancsot 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)Ebben a modulban hozzáadunk egy entities mappát, ahol a modulként modellek lesznek elhelyezve. Itt hozzáadunk egy user.entity.ts fájlt a felhasználói modell leírásával:
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;
}Ahhoz, hogy ezt a modellt „lássa” az alkalmazásunk, importálnunk kell a UsersModule módulba a TypeOrmModule a következő tartalommal:
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 {}Tehát itt importálunk TypeOrmModule, ahol a metódus paramétereként forFeature megadjuk a modullal kapcsolatos modellek listáját.
Ezután létre kell hozni a megfelelő entitást az adatbázisban. Erre a migrációs mechanizmus szolgál. A modellekben történt változások alapján migráció létrehozásához futtassuk a következő parancsot npm run migration:generate -- CreateUserTable:
Spoiler cím
$ npm run migration:generate -- CreateUserTable
A migráció sikeresen generálva lett a következő úton:
/home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts
Kész, 1.96 másodperc alatt.Nem kellett manuálisan migrációt írnunk, minden varázslatos módon történt. Ez nem csoda! De ez még nem minden. Nézzük meg a létrehozott migrációs fájlt:
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"`);
}
}Ahogy látható, automatikusan generálva lett nemcsak a migráció futtatásához szükséges metódus, hanem a visszagörgetéséhez is. Fantasztikus!
Most már csak a migrációt kell élesíteni. Ezt a következő parancs végrehajtásával tehetjük meg:
npm run migration:run.Minden kész, most már a sémaváltoztatások átkonvertálódtak az adatbázisba.
Most létrehozunk egy szolgáltatást, amely a felhasználók kezeléséért felelős, és örökölni fogjuk a TypeOrmCrudService-tól. A szülő konstruktor paramétereként át kell adni a kérdéses entitás tárolóját, esetünkben oldalon lehet végrehajtani a tárolót.
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);
}
}Ez a szolgáltatás szükséges lesz a vezérlőben Miután megállapítottuk, hogy ki küldte a kérést, meg kell határoznunk, hogy az adott alanynak mit engedélyeztek. Egyes szolgáltatásrácsok lehetővé teszik alapvető irányelvek (arról, hogy ki mit tehet) megadását YAML-fájlok formájában vagy parancssoron, míg mások integrációt kínálnak olyan keretrendszerekkel, mint az. A vezérlő létrehozásához írja be a konzolba 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
LÉTREHOZVA /src/users/controllers/users/users.controller.spec.ts (486 byte)
LÉTREHOZVA /src/users/controllers/users/users.controller.ts (99 byte)
FRISSÍTÉS /src/users/users.module.ts (188 byte)Nyissuk meg ezt a vezérlőt, és szerkesszük meg, hogy egy kis varázslatot adjunk hozzá jsx/crud. Az osztályhoz UsersController a következő típusú díszítőt fogunk hozzáadni:
@Crud({
model: {
type: User
}
}) — egy díszítő, amely a szükséges módszereket adja hozzá a modell kezeléséhez a vezérlőhöz. A modell típusa a mezőben van megadva model.type a díszítő konfigurációjában.
A második lépés — meg kell valósítani a CrudController<User>. „A gyűjteményben” a vezérlő kódja a következőképpen néz ki:
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){}
}És ennyi! Most a vezérlő támogatja a modell összes műveletét! Nem hiszi? Próbáljuk ki az alkalmazásunkat a gyakorlatban!
Kérési forgatókönyv létrehozása a TestMace-ben
A szolgáltatásunk teszteléséhez API-kkal való munkára használunk IDE-t. Miért a TestMace? A hasonló termékekhez képest a következő előnyöket kínálja:
- erőteljes változókezelés. Jelenleg több típusú változó létezik, amelyek mindegyike meghatározott szerepet tölt be: beépített változók, dinamikus változók, környezeti változók. Minden változó egy csomóhoz tartozik, támogatva az öröklődés mechanizmusát;
- könnyű forgatókönyv létrehozás programozás nélkül. Erről az alábbiakban lesz szó;
- emberi olvasásra alkalmas formátum, amely lehetővé teszi a projekt tárolását a verziókezelő rendszerekben;
- automatikus kiegészítés, szintaxis kiemelés, változók kiemelése;
- API leírás támogatása Swagger-ből történő importálás lehetőségével.
Indítsuk el a szerverünket a npm start parancsot használva, és próbáljunk hozzáférni a felhasználók listájához. A felhasználók listája a vezérlő konfigurációnk szerint az alábbi URL-en érhető el: localhost:3000/users. Kérjük, tegyen egy kérést ezen az URL-en.
A TestMace indítása után ilyen felületet láthat:
Bal felső oldal található a projektek fája a gyökércsomóponttal. Próbáljuk meg létrehozni az első kérésünket a felhasználók listájának lekérésére. Ehhez hozzunk létre egy csomópontot. Ezt a Project csomópont kontextusmenüjében tehetjük meg Hozzáadás -> Kérési lépés.
A URL mezőbe illessze be a localhost:3000/users-t, majd hajtsa végre a kérést. 200-as kódot fogunk kapni, üres tömbbel a válasz törzsében. Nem meglepő, még senkit sem adtunk hozzá.
Hozzunk létre egy forgatókönyvet, amely a következő lépéseket tartalmazza:
- felhasználó létrehozása;
- lekérdezés az éppen létrehozott felhasználó azonosítója alapján;
- azonosító alapján történő törlés, az első lépésben létrehozott felhasználó.
Tehát, nekilátunk. A kényelem kedvéért hozzunk létre egy . Lényegében ez egy mappa, amelyben elmentjük az összes szkriptet. A Mappa csomópont létrehozásához a Projekt csomópont helyi menüjében ki kell választani Hozzáadás -> Mappa. Nevezzük el a csomópontot check-create. A csomóponton belül check-create létrehozzuk első kérésünket a felhasználó létrehozására. Nevezzük el az éppen létrehozott csomópontot create-user. Jelenleg a csomópontok hierarchiája így fog kinézni:
Lépjünk át a megnyitott create-user csomópontra. Írjuk be a következő paramétereket a kéréshez:
- Kérés típusa — POST
- URL — localhost:3000/users
- Törzs — JSON a következő értékkel
{"email": "user@user.com", "displayName": "Új felhasználó", "username": "user"}
Végezzük el ezt a kérést. Az alkalmazásunk azt mondja, hogy a bejegyzés létrejött.
Nos, nézzük meg ezt a tényt. Annak érdekében, hogy a későbbi lépések során tudjunk dolgozni a létrehozott felhasználó id-jával, ezt a paramétert el kell menteni. Erre nagyszerűen alkalmas a mechanizmusa. Nézzük meg a példánkban, hogyan történik a munka velük. A válasz parsed fülén a csomópont id-jénél a helyi menüben ki kell választani a pontot Hozzárendelés változóhoz. A párbeszédablakban a következő paramétereket kell megadni:
- Node — melyik ősben szeretnénk létrehozni a dinamikus változót. Válasszuk check-create
- Változó neve — a változó nevét. Hívjuk
userId.
Így néz ki a dinamikus változó létrehozásának folyamata:
Most, minden alkalommal, amikor ezt a kérést végrehajtjuk, a dinamikus változó értéke frissülni fog. Mivel a dinamikus változók támogatják a hierarchikus öröklődést, a változó userId elérhető lesz a check-create bármely mélységű csomópont utódai számára.
A következő kérésnél ez a változó hasznos lesz számunkra. Nevezetesen, lekérjük az éppen létrehozott felhasználót. Mint a csomópont utódját check-create létrehozunk egy kérést check-if exists a beállítással url egyenlő localhost:3000/users/${$dynamicVar.userId}. Az ilyen formátumú konstrukció ${variable_name} a változó értékének lekérését jelenti. Mivel dinamikus változónk van, a lekéréshez hivatkoznunk kell az objektumra $dynamicVar, vagyis a dinamikus változóhoz való teljes hivatkozás userId így fog kinézni ${$dynamicVar.userId}. Végezzük el a kérést, és győződjünk meg róla, hogy az adatok helyesen kérdezhetők le.
Már csak az utolsó simítás van hátra — meg kell tennünk a törlési kérést. Erre nemcsak az eltávolítás működésének ellenőrzéséhez van szükség, hanem hogy, mondhatni, rendet tegyünk az adatbázisban, mivel az email és a felhasználónév mezők egyediek. Tehát a check-create csomópontban létrehozunk egy delete-user kérést a következő paraméterekkel
- Kérelem típusa — TÖRLÉS
- URL —
localhost:3000/users/${$dynamicVar.userId}
Futtatjuk. Várunk. Élvezzük az eredményt)
Most pedig bármikor elindíthatjuk ezt a folyamatot. A forgatókönyv elindításához válasszuk ki a kontextusmenüben check-create a csomópontot, amelyik Run.
A csomópontok a forgatókönyvben egymás után fognak végrehajtódni
Ezt a forgatókönyvet elmentheti a projektjébe az alábbiak végrehajtásával File -> Projekt mentése.
Zárás
A cikk formátumába nem fért bele minden a használt eszközökről. Ami a fő ellenfelet illeti — a csomagot jsx/crud — a következő témák maradtak világítás nélkül:
- saját validálás és modellek átalakítása;
- erőteljes kérdezési nyelv és annak kényelmes használata a frontend-en;
- új módszerek felülírása és hozzáadása a crud-vezérlőkhöz;
- swagger támogatás;
- gyorsítótárazás kezelése.
Ám még a cikkben leírtak is elegendők ahhoz, hogy megértsük, hogy még egy ilyen vállalati keretrendszer, mint a NestJS, rendelkezik eszközökkel az alkalmazások gyors prototípus készítésére. És egy ilyen klassz IDE, mint segít a megszokott tempó fenntartásában.
A cikk forráskódja, a projekttel együtt , elérhető a tárolóban . A projekt megnyitásához csak annyit kell tennie, hogy a programban végrehajtja File -> Projekt megnyitása.
Forrás: habr.com
