Atualmente, a REST API se tornou o padrão para o desenvolvimento de aplicações web, permitindo dividir o desenvolvimento em partes independentes. Para UI, atualmente, diversos frameworks populares como Angular, React, Vue e outros são utilizados. Os desenvolvedores de backend podem escolher entre uma ampla variedade de linguagens e frameworks. Hoje, eu gostaria de falar sobre um framework chamado . Nós, na usamos ativamente ele para projetos internos. Usando o nest e o pacote , criaremos uma aplicação CRUD simples.
Por que NestJS
Recentemente, surgiram muitos frameworks de backend na comunidade JavaScript. E se em termos de funcionalidade eles oferecem capacidades semelhantes às do Nest, em um aspecto ele definitivamente se destaca — sua arquitetura. As seguintes características do NestJS permitem criar aplicações industriais e escalar o desenvolvimento para grandes equipes:
- uso do TypeScript como a principal linguagem de desenvolvimento. Embora o NestJS também suporte JavaScript, parte da funcionalidade pode não funcionar, especialmente quando se trata de pacotes de terceiros;
- existência de um container DI, o que permite criar componentes fracamente acoplados;
- a funcionalidade do próprio framework é dividida em componentes intercambiáveis independentes. Por exemplo, sob o capô, pode ser utilizado como framework tanto o , quanto o , para trabalhar com o banco de dados, o nest oferece bindings para , , ;
- O NestJS não depende da plataforma e suporta REST, GraphQL, Websockets, gRPC, etc.
O próprio framework é inspirado no framework frontend Angular e tem muitos aspectos em comum com ele.
Instalação do NestJS e configuração do projeto
O Nest inclui o pacote /cli, который позволяет быстро развернуть базовый каркас приложения. Установим глобально данный пакет:
npm install --global @nest/cliApós a instalação, geraremos a estrutura básica da nossa aplicação com o nome nest-res. Isso é feito usando o comando nest new nest-rest.
nest new nest-rest
dmitrii@dmitrii-HP-ZBook-17-G3:~\/projects $ nest new nest-rest
Vamos criar seu aplicativo em alguns segundos..
CREATE \/nest-rest\/.prettierrc (51 bytes)
CREATE \/nest-rest\/README.md (3370 bytes)
CREATE \/nest-rest\/nest-cli.json (84 bytes)
CREATE \/nest-rest\/nodemon-debug.json (163 bytes)
CREATE \/nest-rest\/nodemon.json (67 bytes)
CREATE \/nest-rest\/package.json (1805 bytes)
CREATE \/nest-rest\/tsconfig.build.json (97 bytes)
CREATE \/nest-rest\/tsconfig.json (325 bytes)
CREATE \/nest-rest\/tslint.json (426 bytes)
CREATE \/nest-rest\/src\/app.controller.spec.ts (617 bytes)
CREATE \/nest-rest\/src\/app.controller.ts (274 bytes)
CREATE \/nest-rest\/src\/app.module.ts (249 bytes)
CREATE \/nest-rest\/src\/app.service.ts (142 bytes)
CREATE \/nest-rest\/src\/main.ts (208 bytes)
CREATE \/nest-rest\/test\/app.e2e-spec.ts (561 bytes)
CREATE \/nest-rest\/test\/jest-e2e.json (183 bytes)
? Qual gerenciador de pacotes você gostaria de usar? yarn
Instalação em andamento...
Projeto nest-rest criado com sucesso
Comece com os seguintes comandos:
$ cd nest-rest
$ yarn run start
Obrigado por instalar o Nest
Considere fazer uma doação para nosso coletivo aberto
para nos ajudar a manter este pacote.
Doe: https:\/\/opencollective.com\/nestComo gerenciador de pacotes, escolheremos yarn.
Neste momento, você pode iniciar o servidor com o comando npm start e acessar o endereço você pode ver a página inicial. No entanto, não estamos aqui para isso e vamos em frente.
Configurando a conexão com o banco de dados
Como SGBD para este artigo, escolhi o PostgreSQL. Sobre gostos não se discute, na minha opinião, este é o SGBD mais maduro, com todas as funcionalidades necessárias. Como já mencionado, o Nest oferece integração com diversos pacotes para trabalhar com bancos de dados. Como minha escolha foi o PostgreSQL, faz sentido escolher o TypeORM como ORM. Vamos instalar os pacotes necessários para a integração com o banco de dados:
yarn add typeorm @nestjs\/typeorm pg
De forma ordenada, para que serve cada pacote:
- typeorm — pacote diretamente relacionado à própria ORM;
- @nestjs\/typeorm — pacote TypeORM para NestJS. Adiciona módulos para importação nos módulos do projeto, além de um conjunto de decoradores auxiliares;
- pg — driver para trabalhar com PostgreSQL.
Ok, os pacotes estão instalados, agora precisamos iniciar o banco de dados. Para implantar o banco, usarei um docker-compose.yml com o seguinte conteúdo:
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:8080Como pode ser visto, este arquivo configura a execução de 2 contêineres:
- db — este é o contêiner diretamente relacionado ao banco de dados. No nosso caso, estamos utilizando a versão 11.2 do PostgreSQL.
- adminer — gerenciador de banco de dados. Fornece uma interface web para visualizar e gerenciar o banco de dados.
Para trabalhar com conexões TCP, adicionei uma configuração com o seguinte conteúdo.
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 hereIsso é tudo, agora você pode iniciar os contêineres com o comando docker-compose up -d. Ou em um console separado com o comando docker-compose up.
Então, instalamos os pacotes, iniciamos o banco de dados, agora precisamos integrá-los. Para isso, você deve adicionar um arquivo ormconfig.js na raiz do projeto com o seguinte conteúdo:
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"
}
}
Esta configuração será usada para o CLI TypeORM.
Vamos examinar esta configuração mais detalhadamente. Nas linhas 3 e 4, obtemos o nome de usuário e a senha das variáveis de ambiente. Isso é conveniente quando você tem vários ambientes (dev, stage, prod, etc.). Por padrão, o nome de usuário é postgres e a senha é example. O resto da configuração é trivial, então vamos focar apenas nos parâmetros mais interessantes:
- synchronize — indica se o esquema do banco de dados deve ser criado automaticamente ao iniciar o aplicativo. Tenha cuidado com esta opção e não a use em produção, caso contrário, você perderá dados. Essa opção é útil durante o desenvolvimento e a depuração do aplicativo. Como alternativa a esta opção, você pode usar o comando
schema:syncdo CLI TypeORM. - dropSchema — redefine o esquema toda vez que uma conexão é estabelecida. Assim como a anterior, esta opção deve ser usada apenas durante o desenvolvimento e a depuração do aplicativo.
- entities — caminhos pelos quais procurar descrições de modelos. Observe que a busca por máscaras é suportada.
- cli.entitiesDir — diretório onde, por padrão, os modelos criados a partir do CLI TypeORM devem ser armazenados.
Para que possamos usar todas as funcionalidades do TypeORM em nosso aplicativo Nest, é necessário importar o módulo TypeOrmModule em AppModule. Ou seja, seu AppModule deve se parecer com o seguinte:
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 {}Como você deve ter notado, no método forRoot é passada a mesma configuração para trabalhar com o banco de dados que está no arquivo ormconfig.ts
Falta um último toque — adicionar algumas tarefas para trabalhar com TypeORM no package.json. O fato é que o CLI foi escrito em JavaScript e é executado no ambiente Node.js. No entanto, todos os nossos modelos e migrações serão escritos em TypeScript. Portanto, precisamos transpilar nossas migrações e modelos antes de usar o CLI. Para isso, precisamos do pacote ts-node:
yarn add -D ts-node
Depois disso, vamos adicionar os comandos necessários no 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"O primeiro comando, typeorm, adiciona uma camada com ts-node para executar o CLI TypeORM. Os demais comandos são atalhos práticos que você, como desenvolvedor, usará quase todos os dias:
migration:generate — cria uma migração com base nas mudanças em seus modelos.
migration:create — cria uma migração vazia.
migration:run — executa as migrações.
Agora está tudo certo, adicionamos os pacotes necessários, configuramos o aplicativo para trabalhar com o banco tanto pelo CLI quanto pelo aplicativo, e também iniciamos o SGBD. É hora de adicionar lógica ao nosso aplicativo.
Instalação de pacotes para criar CRUD
Usando apenas o Nest você pode criar uma API que permite criar, ler, atualizar e excluir uma entidade. Essa solução será a mais flexível, mas em alguns casos pode ser excessiva. Por exemplo, se você precisa criar um protótipo rapidamente, às vezes é possível sacrificar a flexibilidade pela velocidade de desenvolvimento. Muitos frameworks oferecem a funcionalidade de geração de CRUD com base na descrição do modelo de dados de uma determinada entidade. E o Nest não é exceção! Essa funcionalidade é fornecida pelo pacote . Suas possibilidades são bastante interessantes:
- instalação e configuração fáceis;
- independência do SGBD;
- uma poderosa linguagem de consulta com suporte a filtragem, paginação, ordenação, carregamento de relacionamentos e entidades aninhadas, cache, etc.;
- pacote para formação de consultas no front-end;
- sobrescrita fácil de métodos de controladores;
- um pequeno arquivo de configuração;
- suporte à documentação swagger.
A funcionalidade é dividida em vários pacotes:
- — pacote base que fornece o decorador () para geração de rotas, configuração e validação;
- — pacote que fornece um construtor/parser de consultas para uso no lado do front-end;
- — pacote para integração com TypeORM, fornecendo o serviço base TypeOrmCrudService com métodos CRUD para manipulação de entidades no Banco de Dados.
Neste guia, precisaremos dos pacotes jsx/crud e jsx/crud-typeorm. Para começar, vamos instalá-los
yarn add @nestjsx/crud class-transformer class-validatorPacotes e são necessários para a descrição declarativa das regras de transformação de instâncias de modelos e validação de requisições, respectivamente. Esses pacotes são de um único autor, portanto as interfaces são semelhantes.
Implementação direta de CRUD
Como exemplo de modelo, vamos pegar uma lista de usuários. Os usuários terão os seguintes campos: id, nome de usuário, displayName, email. id — campo auto-incremental, email e nome de usuário — campos únicos. Tudo simples! Só falta concretizar nossa ideia na forma de uma aplicação Nest.
Para começar, é necessário criar um módulo tinham endereços de e-mail em domínios, que será responsável pelo trabalho com usuários. Vamos usar o cli do NestJS, e na diretório raiz do nosso projeto, vamos executar o comando 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)Neste módulo, adicionaremos a pasta entities, onde teremos os modelos deste módulo. Especificamente, vamos adicionar aqui o arquivo user.entity.ts com a descrição do modelo de usuários:
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;
}Para que este modelo seja "visto" pela nossa aplicação, é necessário importar no módulo UsersModule o seguinte conteúdo: TypeOrmModule users.module.ts
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 {}Ou seja, aqui estamos importando TypeOrmModule, onde como parâmetro do método forFeature especificamos a lista de modelos que pertencem a este módulo.
Resta criar a respectiva entidade no banco de dados. Para isso, usamos o mecanismo de migrações. Para criar uma migração com base nas alterações nos modelos, é necessário executar o comando npm run migration:generate -- CreateUserTable:
Título do spoiler
$ npm run migration:generate -- CreateUserTable
Migration /home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts foi gerada com sucesso.
Concluído em 1.96s.Nós não precisávamos escrever a migração manualmente, tudo aconteceu de forma mágica. Isso não é um milagre! No entanto, isso ainda não é tudo. Vamos dar uma olhada no arquivo de migração criado:
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"`);
}
}Como você pode notar, foi gerado automaticamente não apenas o método para executar a migração, mas também o método para reverter. Fantástico!
Resta apenas aplicar essa migração. Isso é feito com o seguinte comando:
npm run migration:run.Tudo, agora as alterações do esquema foram transferidas para o banco de dados.
Em seguida, vamos criar um serviço que será responsável pelo trabalho com os usuários e herdá-lo de TypeOrmCrudService. No parâmetro do construtor pai, é necessário passar o repositório da entidade de interesse, no nosso caso, User repositório.
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);
}
}Esse serviço será necessário no controlador tinham endereços de e-mail em domínios. Para criar o controlador, digite no console 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)Vamos abrir este controlador e editá-lo para adicionar um pouco de mágica jsx\/crud. Na classe UsersController adicionaremos um decorador do seguinte tipo:
@Crud({
model: {
type: User
}
}) — este é um decorador que adiciona os métodos necessários ao controlador para trabalhar com o modelo. O tipo do modelo é especificado no campo model.type da configuração do decorador.
O segundo passo — é necessário implementar a interface CrudController<User>. O código do controlador, 'todo', fica assim:
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){}
}E é isso! Agora o controlador suporta todo o conjunto de operações com o modelo! Não acredita? Vamos testar nosso aplicativo na prática!
Criando um script de requisições no TestMace
Para testar nosso serviço, usaremos uma IDE para trabalhar com APIs . Por que TestMace? Comparado a produtos semelhantes, ele tem as seguintes vantagens:
- poderoso manejo de variáveis. Até agora, existem vários tipos de variáveis, cada uma desempenhando um papel específico: variáveis embutidas, variáveis dinâmicas, variáveis de ambiente. Cada variável pertence a um nó que suporta o mecanismo de herança;
- criação fácil de scripts sem programação. Sobre isso falaremos mais adiante;
- formato legível por humanos, permitindo salvar o projeto em sistemas de controle de versão;
- autocompletar, realce de sintaxe, realce de valores de variáveis;
- suporte à descrição de APIs, com possibilidade de importação do Swagger.
Vamos iniciar nosso servidor com o comando npm start e tentar acessar a lista de usuários. A lista de usuários, de acordo com nossa configuração do controlador, pode ser obtida pelo url localhost:3000\/users. Vamos fazer uma requisição para esse url.
Após iniciar o TestMace, você pode ver essa interface:
No canto superior esquerdo, está a árvore de projetos com o nó raiz. Vamos tentar criar a primeira requisição para obter a lista de usuários. Para isso, criaremos um nó. Isso é feito no menu de contexto do nó Project Adicionar nó -> RequestStep.
No campo URL, insira localhost:3000/users e execute a solicitação. Receberemos o código 200 com um array vazio no corpo da resposta. Isso é compreensível, pois ainda não adicionamos ninguém.
Vamos criar um script que incluirá os seguintes passos:
- criação de um usuário;
- solicitação pelo id do usuário recém-criado;
- remoção pelo id do usuário criado no passo 1.
Então, vamos lá. Para удобства, criaremos um nó do tipo . Essencialmente, isso é apenas uma pasta onde salvaremos todo o script. Para criar um nó de Pasta, é necessário escolher no menu de contexto do nó do Projeto Adicionar nó -> Pasta. Nomearemos o nó check-create. Dentro do nó check-create criaremos nossa primeira solicitação para criar um usuário. Nomearemos o nó recém-criado create-user. Portanto, neste momento, a hierarquia dos nós ficará assim:
Vamos para a guia do nó aberto. create-user Insira os seguintes parâmetros para a solicitação:
- Tipo de solicitação - POST
- URL - localhost:3000/users
- Corpo - JSON com o valor
{"email": "user@user.com", "displayName": "Novo usuário", "username": "user"}
Executaremos esta solicitação. Nosso aplicativo informa que o registro foi criado.
Bem, vamos verificar este fato. Para nos passos subsequentes, para operar com o id do usuário criado, este parâmetro precisa ser salvo. Para isso, o mecanismo de é ideal. Vamos examinar nosso exemplo para entender como isso funciona. Na guia de resposta analisada, no menu de contexto do nó id, selecione a opção Atribuir à variável. Na janela de diálogo, precisamos definir os seguintes parâmetros:
- Nó — em qual ancestral criar a variável dinâmica. Escolheremos check-create
- Nome da variável — o nome dessa variável. Nomearemos como
userId.
Assim é como o processo de criação de uma variável dinâmica se parece:
Agora, a cada execução desta solicitação, o valor da variável dinâmica será atualizado. E como as variáveis dinâmicas suportam o mecanismo de herança hierárquica, a variável userId estará disponível nos descendentes check-create de nós de qualquer nível de profundidade.
Na próxima solicitação, essa variável será útil para nós. Mais especificamente, solicitaremos o usuário recém-criado. Como descendente do nó check-create criaremos a solicitação check-if exists com o parâmetro url igual a localhost:3000/users/${$dynamicVar.userId}. A construção do tipo ${variable_name} é como obter o valor da variável. Como temos uma variável dinâmica, para obtê-la, precisamos nos referir ao objeto $dynamicVar, ou seja, uma chamada completa para a variável dinâmica userId terá a seguinte aparência ${$dynamicVar.userId}. Vamos fazer a solicitação e garantir que os dados solicitados estejam corretos.
Falta o último toque — fazer a solicitação de exclusão. Precisamos dele não apenas para verificar se a exclusão funciona, mas também, por assim dizer, para limpar o banco, uma vez que os campos de email e nome de usuário são únicos. Então, no nó check-create, vamos criar a solicitação delete-user com os seguintes parâmetros
- Tipo de solicitação — DELETE
- URL —
localhost:3000/users/${$dynamicVar.userId}
Vamos lá. Esperamos. Aproveitamos o resultado)
E agora podemos executar completamente este script a qualquer momento. Para executar o script, é necessário selecionar no menu de contexto check-create o item do nó Run.
Os nós no script serão executados um após o outro
Este script você pode salvar em seu projeto, realizando File -> Save project.
Conclusão
O formato deste artigo simplesmente não conseguiu conter todos os recursos das ferramentas utilizadas. Quanto ao principal culpado — o pacote jsx/crud — ficaram sem cobertura os seguintes temas:
- validação e transformação personalizadas de modelos;
- uma poderosa linguagem de consultas e seu uso conveniente no frontend;
- sobrescrita e adição de novos métodos nos crud-controladores;
- suporte ao swagger;
- gerenciamento de cache.
No entanto, o que está descrito no artigo é suficiente para entender que até mesmo um framework empresarial como o NestJS tem ferramentas em sua manga para prototipagem rápida de aplicações. E uma IDE tão ótima como permite manter o ritmo estabelecido.
O código fonte deste artigo, juntamente com o projeto , está disponível no repositório . Para abrir o projeto basta executar no aplicativo File -> Open project.
Fonte: habr.com
