Saiki, REST API wis dadi standar kanggo pangembangan aplikasi web, saéngga pangembangan bisa dipérang dadi bagéan independen. Macem-macem kerangka populer kayata Angular, React, Vue lan liya-liyane saiki digunakake kanggo UI. Pangembang backend bisa milih saka macem-macem basa lan kerangka kerja. Dina iki aku arep ngomong babagan kerangka kaya . Kita ing Kita digunakake kanthi aktif kanggo proyek internal. Nggunakake nest lan paket , kita bakal nggawe aplikasi CRUD prasaja.
Kenapa NestJS
Bubar, cukup akeh kerangka backend sing muncul ing komunitas JavaScript. Lan yen ing syarat-syarat fungsi padha nyedhiyani kapabilitas kanggo Nest, banjur ing siji bab iku mesthi menang - iki arsitektur. Fitur NestJS ing ngisor iki ngidini sampeyan nggawe aplikasi industri lan pangembangan skala kanggo tim gedhe:
- nggunakake TypeScript minangka basa pangembangan utama. Sanajan NestJS ndhukung JavaScript, sawetara fungsi bisa uga ora bisa digunakake, utamane yen kita ngomong babagan paket pihak katelu;
- ngarsane wadhah DI, sing ngidini sampeyan nggawe komponen sing digabungake;
- Fungsi kerangka kasebut dhewe dipérang dadi komponen sing bisa diganti. Contone, ing hood minangka framework bisa digunakake minangka lan , kanggo nggarap database, nest metu saka kothak menehi bindings kanggo , , ;
- NestJS minangka platform agnostik lan ndhukung REST, GraphQL, Websockets, gRPC, lsp.
Kerangka kasebut dhewe diilhami dening kerangka frontend Angular lan sacara konsep duwe akeh sing padha.
Nginstal NestJS lan Deploying Project
Nest ngemot paket / cli, sing ngijini sampeyan kanggo cepet masang framework aplikasi dhasar. Ayo instal paket iki sacara global:
npm install --global @nest/cliSawise instalasi, kita bakal ngasilake kerangka dhasar aplikasi kanthi jeneng kasebut nest-rest. Iki rampung nggunakake printah nest new nest-rest.
nest anyar nest-rest
dmitrii@dmitrii-HP-ZBook-17-G3:~/projects $ nest new nest-rest
We will scaffold your app in a few seconds..
CREATE /nest-rest/.prettierrc (51 bytes)
CREATE /nest-rest/README.md (3370 bytes)
CREATE /nest-rest/nest-cli.json (84 bytes)
CREATE /nest-rest/nodemon-debug.json (163 bytes)
CREATE /nest-rest/nodemon.json (67 bytes)
CREATE /nest-rest/package.json (1805 bytes)
CREATE /nest-rest/tsconfig.build.json (97 bytes)
CREATE /nest-rest/tsconfig.json (325 bytes)
CREATE /nest-rest/tslint.json (426 bytes)
CREATE /nest-rest/src/app.controller.spec.ts (617 bytes)
CREATE /nest-rest/src/app.controller.ts (274 bytes)
CREATE /nest-rest/src/app.module.ts (249 bytes)
CREATE /nest-rest/src/app.service.ts (142 bytes)
CREATE /nest-rest/src/main.ts (208 bytes)
CREATE /nest-rest/test/app.e2e-spec.ts (561 bytes)
CREATE /nest-rest/test/jest-e2e.json (183 bytes)
? Which package manager would you ️ to use? yarn
Installation in progress...
Successfully created project nest-rest
Get started with the following commands:
$ cd nest-rest
$ yarn run start
Thanks for installing Nest
Please consider donating to our open collective
to help us maintain this package.
Donate: https://opencollective.com/nestKita bakal milih benang minangka manajer paket.
Ing jalur iki sampeyan bisa miwiti server karo printah npm start lan arep menyang alamat sampeyan bisa ndeleng kaca utama. Nanging, iki dudu sebabe kita wis kumpul ing kene lan kita terus maju.
Nyetel karya karo database
Aku milih PostrgreSQL minangka DBMS kanggo artikel iki. Ora ana regejegan babagan rasa; miturut pendapatku, iki minangka DBMS sing paling diwasa, duwe kabeh kemampuan sing dibutuhake. Kaya sing wis kasebut, Nest nyedhiyakake integrasi karo macem-macem paket kanggo nggarap database. Amarga Wiwit pilihanku tiba ing PostgreSQL, mesthi logis kanggo milih TypeORM minangka ORM. Ayo nginstal paket sing dibutuhake kanggo integrasi karo database:
yarn add typeorm @nestjs/typeorm pg
Supaya, apa saben paket dibutuhake:
- typeorm - paket langsung saka ORM dhewe;
- @nestjs/typeorm - paket TypeORM kanggo NestJS. Nambah modul kanggo ngimpor menyang modul project, uga pesawat saka dekorator helper;
- pg - driver kanggo nggarap PostgreSQL.
Oke, paket wis diinstal, saiki sampeyan kudu miwiti database dhewe. Kanggo masang database, aku bakal nggunakake docker-compose.yml kanthi isi ing ngisor iki:
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:8080Kaya sing sampeyan ngerteni, file iki ngatur peluncuran 2 wadah:
- db minangka wadhah sing langsung ngemot database. Ing kasus kita, postgresql versi 11.2 digunakake;
- administrator—pengurus database. Nyedhiyani antarmuka web kanggo ndeleng lan ngatur database.
Kanggo nggarap sambungan tcp, aku nambahake konfigurasi ing ngisor iki.
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 hereIku kabeh, sampeyan bisa miwiti kontaner karo printah docker-compose up -d. Utawa ing console kapisah karo printah docker-compose up.
Dadi, paket wis diinstal, database wis diluncurake, sing isih ana yaiku nggawe kanca-kanca. Kanggo nindakake iki, sampeyan kudu nambah file ing ngisor iki kanggo ROOT project: ormconfig.js:
ormconfig.js
const process = require('process');
const username = process.env.POSTGRES_USER || "postgres";
const password = process.env.POSTGRES_PASSWORD || "example";
module.exports = {
"type": "postgres",
"host": "localhost",
"port": 5432,
username,
password,
"database": "postgres",
"synchronize": true,
"dropSchema": false,
"logging": true,
"entities": [__dirname + "/src/**/*.entity.ts", __dirname + "/dist/**/*.entity.js"],
"migrations": ["migrations/**/*.ts"],
"subscribers": ["subscriber/**/*.ts", "dist/subscriber/**/.js"],
"cli": {
"entitiesDir": "src",
"migrationsDir": "migrations",
"subscribersDir": "subscriber"
}
}
Konfigurasi iki bakal digunakake kanggo typeorm cli.
Ayo ndeleng konfigurasi iki kanthi luwih rinci. Ing baris 3 lan 4 kita entuk jeneng pangguna lan sandhi saka variabel lingkungan. Iki trep yen sampeyan duwe sawetara lingkungan (dev, panggung, prod, lsp). Kanthi gawan, jeneng panganggo iku postgres lan sandhi minangka conto. Konfigurasi liyane ora pati penting, mula kita bakal fokus mung ing paramèter sing paling menarik:
- sinkronisasi - Nuduhake manawa skema database kudu digawe kanthi otomatis nalika aplikasi diwiwiti. Ati-ati karo pilihan iki lan aja digunakake ing produksi, yen ora, sampeyan bakal kelangan data. Opsi iki trep nalika ngembangake lan debugging aplikasi. Minangka alternatif kanggo pilihan iki, sampeyan bisa nggunakake printah
schema:syncsaka CLI TypeORM. - dropSchema - ngreset skema saben-saben sambungan digawe. Kaya sing sadurunge, pilihan iki mung kudu digunakake sajrone pangembangan lan debugging aplikasi.
- èntitas - path kanggo nggoleki katrangan model. Elinga yen telusuran kanthi topeng didhukung.
- cli.entitiesDir minangka direktori ing ngendi model sing digawe saka TypeORM CLI kudu disimpen kanthi standar.
Supaya kita bisa nggunakake kabeh fitur TypeORM ing aplikasi Nest kita, kita kudu ngimpor modul TypeOrmModule в AppModule. Sing. Panjenengan AppModule bakal katon kaya iki:
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 {}Minangka sampeyan bisa uga wis ngeweruhi, cara forRoot konfigurasi padha kanggo nggarap database ditransfer minangka ing file ormconfig.ts
Sentuhan pungkasan tetep - tambahake sawetara tugas kanggo nggarap TypeORM ing package.json. Kasunyatane yaiku CLI ditulis ing javascript lan mlaku ing lingkungan nodejs. Nanging, kabeh model lan migrasi kita bakal ditulis ing typescript. Mulane, perlu transpilate migrasi lan model sadurunge nggunakake CLI. Kanggo iki kita butuh paket ts-node:
yarn add -D ts-node
Sawise iku, tambahake perintah sing dibutuhake menyang 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"Printah pisanan, typeorm, nambah bungkus ts-node kanggo mbukak cli TypeORM. Prentah sing isih ana minangka trabasan sing trep sing sampeyan, minangka pangembang, bakal digunakake meh saben dina:
migration:generate - nggawe migrasi adhedhasar owah-owahan ing model sampeyan.
migration:create - nggawe migrasi kosong.
migration:run - miwiti migrasi.
Ya, saiki, kita wis nambahake paket sing dibutuhake, ngonfigurasi aplikasi kanggo nggarap database saka cli lan saka aplikasi kasebut dhewe, lan uga ngluncurake DBMS. Iku wektu kanggo nambah logika kanggo aplikasi kita.
Nginstal paket kanggo nggawe CRUD
Mung nggunakake Nest, sampeyan bisa nggawe API sing ngidini sampeyan nggawe, maca, nganyari, lan mbusak entitas. Solusi iki bakal dadi fleksibel sabisa, nanging ing sawetara kasus bakal keluwih. Contone, yen sampeyan kudu cepet nggawe prototipe, sampeyan bisa asring kurban keluwesan kanggo kacepetan pembangunan. Akeh kerangka nyedhiyakake fungsi kanggo ngasilake CRUD kanthi njlentrehake model data entitas tartamtu. Lan Nest ora istiméwa! Fungsi kasebut diwenehake dening paket kasebut . Kapabilitas kasebut menarik banget:
- instalasi lan konfigurasi gampang;
- kamardikan DBMS;
- basa pitakon sing kuat kanthi kemampuan kanggo nyaring, ngurutake, ngurutake, mbukak hubungan lan entitas bersarang, caching, lsp;
- paket kanggo ngasilake panjalukan ing ngarep-mburi;
- gampang overriding saka cara controller;
- konfigurasi cilik;
- dhukungan dokumentasi swagger.
Fungsi kasebut dipérang dadi sawetara paket:
- - paket dhasar sing decorator nyedhiyani () kanggo generasi rute, konfigurasi lan validasi;
- - paket sing nyedhiyakake pembangun pitakon / parser kanggo digunakake ing sisih ngarep;
- - paket kanggo integrasi karo TypeORM, nyedhiyakake layanan TypeOrmCrudService dhasar kanthi metode CRUD kanggo nggarap entitas ing database.
Ing tutorial iki kita butuh paket jsx/crud lan jsx/crud-typeorm. Pisanan, ayo dilebokake
yarn add @nestjsx/crud class-transformer class-validatorPaket и ing aplikasi iki dibutuhake kanggo katrangan deklaratif aturan kanggo ngowahi conto model lan validasi panjalukan mlebu, mungguh. Paket kasebut saka penulis sing padha, mula antarmuka sing padha.
Implementasi langsung CRUD
Kita bakal njupuk dhaptar pangguna minangka conto model. Pangguna bakal duwe lapangan ing ngisor iki: id, username, displayName, email. id - lapangan nambah otomatis, email и username - kothak unik. Iku prasaja! Sing isih ana yaiku ngetrapake ide kita ing bentuk aplikasi Nest.
Pisanan sampeyan kudu nggawe modul users, sing bakal tanggung jawab kanggo nggarap pangguna. Ayo nggunakake cli saka NestJS lan nglakokake perintah kasebut ing direktori root proyek kita nest g module users.
pangguna modul nest g
dmitrii@dmitrii-HP-ZBook-17-G3:~/projects/nest-rest git:(master*)$ nest g module users
CREATE /src/users/users.module.ts (82 bytes)
UPDATE /src/app.module.ts (312 bytes)Ing modul iki kita bakal nambah folder entitas, ing ngendi kita bakal duwe model modul iki. Utamane, ayo ditambahake ing kene file user.entity.ts kanthi katrangan babagan model pangguna:
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;
}Supaya model iki "katon" dening aplikasi kita, perlu ing modul UsersModule ngimpor TypeOrmModule isi ing ngisor iki:
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 {}Sing, kene kita ngimpor TypeOrmModule, ngendi minangka parameter metode forFeature Kita nuduhake dhaptar model sing ana gandhengane karo modul iki.
Kabeh sing isih ana yaiku nggawe entitas sing cocog ing basis data. Mekanisme migrasi digunakake kanggo tujuan kasebut. Kanggo nggawe migrasi adhedhasar owah-owahan ing model, sampeyan kudu mbukak printah npm run migration:generate -- CreateUserTable:
Judul spoiler
$ npm run migration:generate -- CreateUserTable
Migration /home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts has been generated successfully.
Done in 1.96s.Kita ora kudu nulis migrasi kanthi manual, kabeh kedadeyan kanthi ajaib. Apa ora iki mukjijat! Nanging, ora mung kuwi. Ayo goleki file migrasi sing digawe:
1563346135367-CreateUserTable.ts
import {MigrationInterface, QueryRunner} from "typeorm";
export class CreateUserTable1563346816726 implements MigrationInterface {
public async up(queryRunner: QueryRunner): Promise<any> {
await queryRunner.query(`CREATE TABLE "user" ("id" SERIAL NOT NULL, "email" character varying NOT NULL, "username" character varying NOT NULL, "displayName" character varying, CONSTRAINT "UQ_e12875dfb3b1d92d7d7c5377e22" UNIQUE ("email"), CONSTRAINT "UQ_78a916df40e02a9deb1c4b75edb" UNIQUE ("username"), CONSTRAINT "PK_cace4a159ff9f2512dd42373760" PRIMARY KEY ("id"))`);
}
public async down(queryRunner: QueryRunner): Promise<any> {
await queryRunner.query(`DROP TABLE "user"`);
}
}Nalika sampeyan bisa ndeleng, ora mung cara kanggo miwiti migrasi digawe kanthi otomatis, nanging uga cara kanggo muter maneh. Fantastic!
Kabeh sing isih ana yaiku ngluncurake migrasi iki. Iki rampung kanthi printah ing ngisor iki:
npm run migration:run.Mekaten, saiki owah-owahan skema wis migrasi menyang database.
Sabanjure, kita bakal nggawe layanan sing bakal tanggung jawab nggarap pangguna lan entuk warisan TypeOrmCrudService. Repositori entitas kapentingan kudu diterusake menyang parameter konstruktor induk, ing kasus kita User gudang.
users.service.ts
import { Injectable } from '@nestjs/common';
import { TypeOrmCrudService } from '@nestjsx/crud-typeorm';
import { User } from '../../entities/user.entity';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
@Injectable()
export class UsersService extends TypeOrmCrudService<User>{
constructor(@InjectRepository(User) usersRepository: Repository<User>){
super(usersRepository);
}
}Kita butuh layanan iki ing pengontrol users. Kanggo nggawe controller, ketik console nest g controller users/controllers/users
pangguna nest g controller / controller / kedhaftar
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)Ayo mbukak controller iki lan ngowahi kanggo nambah sihir sethitik jsx / crud. Saben kelas UsersController Ayo ditambahake dekorator kaya iki:
@Crud({
model: {
type: User
}
}) minangka dekorator sing nambahake pengontrol cara sing dibutuhake kanggo nggarap model kasebut. Jinis model dituduhake ing lapangan model.type konfigurasi dekorator.
Langkah kapindho yaiku ngleksanakake antarmuka CrudController<User>. Kode pengontrol "Dirakit" katon kaya iki:
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){}
}Lan iku kabeh! Saiki controller ndhukung kabeh set operasi karo model! Ora percoyo aku? Ayo coba aplikasi kita ing tumindak!
Nggawe Script Query ing TestMace
Kanggo nguji layanan kita bakal nggunakake IDE kanggo nggarap API . Kenapa TestMace? Dibandhingake karo produk sing padha, nduweni kaluwihan ing ngisor iki:
- karya kuat karo variabel. Saiki, ana sawetara jinis variabel, sing saben duwe peran tartamtu: variabel sing dibangun, variabel dinamis, variabel lingkungan. Saben variabel kalebu simpul kanthi dhukungan kanggo mekanisme warisan;
- Nggawe skrip kanthi gampang tanpa pamrograman. Iki bakal dibahas ing ngisor iki;
- format sing bisa diwaca manungsa sing ngidini sampeyan nyimpen proyek ing sistem kontrol versi;
- autocompletion, nyorot sintaks, nyorot nilai variabel;
- Dhukungan deskripsi API kanthi kemampuan ngimpor saka Swagger.
Ayo dadi miwiti server kita karo printah npm start lan nyoba ngakses dhaptar pangguna. Dhaptar pangguna, miturut konfigurasi pengontrol, bisa dipikolehi saka url localhost:3000/users. Ayo nggawe panjalukan kanggo url iki.
Sawise mbukak TestMace sampeyan bisa ndeleng antarmuka kaya iki:
Ing sisih kiwa ndhuwur ana wit proyek kanthi simpul ROOT . Ayo nyoba nggawe panjalukan pisanan kanggo entuk dhaptar pangguna. Kanggo iki kita bakal nggawe simpul Iki rampung ing menu konteks simpul Project Tambah simpul -> RequestStep.
Ing kolom URL, tempel localhost:3000/users lan mbukak panjalukan. Kita bakal nampa kode 200 karo array kosong ing awak respon. Bisa dingerteni, kita durung nambah sapa wae.
Ayo nggawe skrip sing bakal kalebu langkah-langkah ing ngisor iki:
- nggawe pangguna;
- njaluk id pangguna sing mentas digawe;
- mbusak dening id pangguna sing digawe ing langkah 1.
Dadi, ayo padha lunga. Kanggo penak, ayo nggawe simpul kaya . Intine, iki mung folder sing bakal disimpen kabeh naskah. Kanggo nggawe simpul Folder, pilih Project saka menu konteks simpul Tambah simpul -> Folder. Ayo nelpon node mriksa-nggawe. Ing njero simpul mriksa-nggawe Ayo nggawe panjalukan pisanan kanggo nggawe pangguna. Ayo nelpon simpul sing mentas digawe nggawe-user. Tegese, saiki hierarki simpul bakal katon kaya iki:
Ayo menyang tab mbukak nggawe-user simpul. Ayo ketik paramèter ing ngisor iki kanggo panyuwunan:
- Jinis panjaluk - POST
- URL - localhost: 3000 / pangguna
- Badan - JSON kanthi nilai
{"email": "[email protected]", "displayName": "New user", "username": "user"}
Ayo padha netepi panjaluk iki. Aplikasi kita ujar manawa rekaman wis digawe.
Ayo padha mriksa kasunyatan iki. Supaya bisa digunakake nganggo id pangguna sing digawe ing langkah-langkah sabanjure, parameter iki kudu disimpen. Mekanisme iki sampurna kanggo iki. . Ayo nggunakake conto kita kanggo ndeleng carane bisa karo wong-wong mau. Ing tab sing diurai saka respon, ing jejere simpul id ing menu konteks, pilih item kasebut Nemtokake kanggo variabel. Ing kothak dialog sampeyan kudu nyetel paramèter ing ngisor iki:
- Node - kang saka leluhur kanggo nggawe variabel dinamis. Ayo padha milih mriksa-nggawe
- Jeneng variabel - jeneng variabel iki. Ayo telpon
userId.
Mangkene proses nggawe variabel dinamis:
Saiki, saben pitakon iki dieksekusi, nilai variabel dinamis bakal dianyari. Lan amarga variabel dinamis ndhukung mekanisme warisan hirarkis, variabel userId bakal kasedhiya ing turunan mriksa-nggawe simpul saka sembarang tingkat nesting.
Variabel iki bakal migunani kanggo kita ing panjalukan sabanjure. Yaiku, kita bakal njaluk pangguna sing mentas digawe. Minangka anak saka simpul mriksa-nggawe kita bakal nggawe panjalukan mriksa-yen ana karo parameter url padha localhost:3000/users/${$dynamicVar.userId}. Deleng desain ${variable_name} iki entuk nilai variabel. Amarga Kita duwe variabel dinamis, supaya sampeyan kudu ngakses obyek kasebut $dynamicVar, yaiku ngakses variabel dinamis kanthi lengkap userId bakal katon kaya iki ${$dynamicVar.userId}. Ayo tindakake panjalukan lan priksa manawa data dijaluk kanthi bener.
Langkah pungkasan sing isih ana yaiku njaluk pambusakan. Kita mbutuhake ora mung kanggo mriksa operasi pambusakan, nanging uga, supaya bisa ngomong, kanggo ngresiki dhewe ing database, amarga Kolom email lan jeneng pangguna unik. Dadi, ing simpul mriksa-gawe kita bakal nggawe panjalukan delete-user kanthi paramèter ing ngisor iki
- Jinis panjalukan - DELETE
- URL -
localhost:3000/users/${$dynamicVar.userId}
Ayo diluncurake. We ngenteni. Kita seneng asil)
Saiki, kita bisa mbukak kabeh skrip iki kapan wae. Kanggo mbukak skrip sampeyan kudu milih saka menu konteks mriksa-nggawe item simpul Run.
Node ing skrip bakal dieksekusi siji-sijine
Sampeyan bisa nyimpen skrip iki menyang proyek sampeyan kanthi mlaku File -> Simpen proyek.
kesimpulan
Kabeh fitur alat sing digunakake mung ora cocog karo format artikel iki. Minangka pelaku utama - paket jsx/crud - topik ing ngisor iki tetep ditemokake:
- validasi adat lan transformasi model;
- basa pitakon sing kuat lan panggunaan sing trep ing ngarep;
- redefining lan nambah cara anyar kanggo pengontrol crud;
- dhukungan swagger;
- manajemen caching.
Nanging, sanajan sing diterangake ing artikel kasebut cukup kanggo mangerteni manawa kerangka perusahaan kaya NestJS duwe alat kanggo prototipe aplikasi kanthi cepet. Lan IDE kelangan kaya ngijini sampeyan kanggo njaga jangkah tartamtu.
Kode sumber kanggo artikel iki, bebarengan karo proyek , kasedhiya ing repositori . Kanggo mbukak proyek mung nindakaken ing app File -> Open project.
Source: www.habr.com