API для mysql-simple-rpc

Серверное приложение основанное на mysql-simple-rpc

git clone git://git.appcode.pw/mysql-simple-rpc.git
npm install
# в файле ~/configs/app.json меняет строку подключения
cd refresh
npm install
cd ..
node refresh # обновляем схемы
node generator # генерируем провайдер

поддерживают следующие открытые API:

  • ~/tpl/:type/:folder/:name — получение общих шаблонов
  • ~/tpl-api/:type/:name/:field? — получение специфичных шаблонов

Читать далее «API для mysql-simple-rpc»

Плагин autotest-plugin для VSCode

Плагин предназначен для автоматического тестирования проектов на nodejs

Для корректной работы плагина требуется наличие следующих утилит:

  • jsdoc
    npm install -g jsdoc
    jsdoc -v // для проверки
  • nodeunit
    npm install -g nodeunit
    nodeunit -v // для проверки

Инструкция по генерации и установке плагина

npm install -g vsce // эту команду можно не выполнять если пакет vsce был установлен до этого. подробнее https://code.visualstudio.com/docs/extensions/publish-extension
git clone git://git.appcode.pw/autotest-plugin.git
npm install
vsce package

Читать далее «Плагин autotest-plugin для VSCode»

Отладка nodejs которое работает через IIS

Устанавливаем

npm install -g node-inspect

В web.config system.webServer добавляем

<iisnode loggingEnabled="true" nodeProcessCommandLine=""%programfiles%\nodejs\node.exe" --inspect-brk" />

Открываем сайт в браузере Chrome (страница должна долго грузиться), затем в браузере вводим

chrome://inspect

И должно быть одно приложение, которое слушает порт 9229, нажимаем на него и снимаем breakpoint

Генерация БД для MySql при помощи утилиты mysql-db-generator

Для быстрой генерации БД MySql применяется утилита:

git clone git://git.appcode.pw/mysql-db-generator.git

После выполнения указанной выше команду, выполнить следующую

node index dbname=[dbname] username=[username]

, где

  • db:string — имя создаваемой БД
  • username:string — имя пользователя для безопасности

В результате выполнения будет сформирован файл query.sql

Структура приложения

  • templates — каталог для хранения шаблонов для создания запросов
    • functions — функции
    • tables — таблицы
    • views — представления
  • index — главный файл для формирования запроса

Утилита генерации схемы БД для MySql db-schema-mysql

git clone git://git.appcode.pw/db-schema-mysql.git

Модуль генерирует файлы *.schema с наименованием сущностей.

var main = require('db-schema-mysql');
main(connectionString, outputPath, override);

,где:

  • connectionString: string — строка подключения к БД
  • outputPath: string — выходной каталог для хранения *.schema
  • override: boolean — необязательный параметр. Предназначен для указания принудительной перезаписи исходных файлов. Применяется в процессе настройки и тестирования

Структура файла *.schema

*.schema — файл типа json с комментариями. Хранит структуру таблицы, view, процедуры

//#overwrite
{
    "TABLE_NAME": "application_projects",
    "TABLE_TYPE": "BASE TABLE",
    "TABLE_TITLE": "Тип приложения",
    "PRIMARY_KEY": "id",
    "TABLE_COMMENT": '',
    "FIELDS":[{
        "COLUMN_NAME": "description",
        "COLUMN_DEFAULT_VALUE": ,
        "IS_NULLABLE": "NO",
        "DATA_TYPE": "text",
        "CHARACTER_MAXIMUM_LENGTH": 65535,
        "NUMERIC_PRECISION": ,
        "NUMERIC_SCALE": ,
        "COLUMN_KEY": "",
        "EXTRA": "",
        "COLUMN_COMMENT": "Описание",
        "REFERENCED_COLUMN_NAME": ,
        "REFERENCED_TABLE_NAME": 
    }, {
        "COLUMN_NAME": "id",
        "COLUMN_DEFAULT_VALUE": ,
        "IS_NULLABLE": "NO",
        "DATA_TYPE": "int",
        "CHARACTER_MAXIMUM_LENGTH": ,
        "NUMERIC_PRECISION": 10,
        "NUMERIC_SCALE": 0,
        "COLUMN_KEY": "PRI",
        "EXTRA": "auto_increment",
        "COLUMN_COMMENT": "Идентификатор",
        "REFERENCED_COLUMN_NAME": ,
        "REFERENCED_TABLE_NAME": 
    }, {
        "COLUMN_NAME": "name",
        "COLUMN_DEFAULT_VALUE": ,
        "IS_NULLABLE": "NO",
        "DATA_TYPE": "varchar",
        "CHARACTER_MAXIMUM_LENGTH": 255,
        "NUMERIC_PRECISION": ,
        "NUMERIC_SCALE": ,
        "COLUMN_KEY": "",
        "EXTRA": "",
        "COLUMN_COMMENT": "Наименование",
        "REFERENCED_COLUMN_NAME": ,
        "REFERENCED_TABLE_NAME": 
    }, {
        "COLUMN_NAME": "outputFileName",
        "COLUMN_DEFAULT_VALUE": ,
        "IS_NULLABLE": "NO",
        "DATA_TYPE": "varchar",
        "CHARACTER_MAXIMUM_LENGTH": 255,
        "NUMERIC_PRECISION": ,
        "NUMERIC_SCALE": ,
        "COLUMN_KEY": "",
        "EXTRA": "",
        "COLUMN_COMMENT": "Имя выходного файла",
        "REFERENCED_COLUMN_NAME": ,
        "REFERENCED_TABLE_NAME": 
    }]
}

, где:

  • TABLE_NAME: string — наименование сущности
  • TABLE_TYPE: string — тип сущности. Например BASE TABLE, VIEW, PROCEDURE
  • TABLE_TITLE: string — заголовок таблицы
  • TABLE_COMMENT: string — описание таблицы
  • PRIMARY_KEY: string — первичный ключ. Может быть пустым для VIEW и PROCEDURE
  • FIELDS: any[] — набор полей
    • COLUMN_NAME: string — наименование колонки
    • COLUMN_DEFAULT_VALUE: any — значение по умолчанию
    • IS_NULLABLE: string — YES — может быть null’ом, NO — не может быть null’ом
    • DATA_TYPE: string — тип колонки. Например text, int и т. д.
    • CHARACTER_MAXIMUM_LENGTH: number — длина строки. Указывается только для строковых типов
    • NUMERIC_PRECISION: number — длина числового поля
    • NUMERIC_SCALE: number — количество знаков после запятой для числового поля
    • COLUMN_KEY: string — тип колонки
      • PRI — является первичным ключом
      • MUL — является FK
    • EXTRA: string тип генерации для первичного ключа. Например auto_increment
    • COLUMN_COMMENT: string — описание колонки
    • REFERENCED_COLUMN_NAME: string — связь с колонкой другой таблицы. Указывается наименование колонки
    •  REFERENCED_TABLE_NAME: string — наименование таблицы с которой происходит связь

Выполнение через командную строку

node index connection=[connectionString] output=[output] override=[true|false]

, где

    • connection: string — строка подключения к БД
    • output: string — выходной каталог
    • override: boolean — переопределение данных
Сортировка колонок
Первичную сортировку колонок можно производить, если в наименовании колонки указывать будет указан префикс [e000]
Например:
[e100] Раздел1

Тогда schema будет выглядеть следующим образом:

{
    "TABLE_NAME": "application_projects",
    "TABLE_TYPE": "BASE TABLE",
    "TABLE_TITLE": "Тип приложения",
    "PRIMARY_KEY": "id",
    "TABLE_COMMENT": '',
    "FIELDS":[{
        "COLUMN_NAME": "description",
        "COLUMN_DEFAULT_VALUE": ,
        "IS_NULLABLE": "NO",
        "DATA_TYPE": "text",
        "CHARACTER_MAXIMUM_LENGTH": 65535,
        "NUMERIC_PRECISION": ,
        "NUMERIC_SCALE": ,
        "COLUMN_KEY": "",
        "EXTRA": "",
        "COLUMN_COMMENT": "Описание",
        "REFERENCED_COLUMN_NAME": ,
        "REFERENCED_TABLE_NAME": ,
        "ORDER": 100 // тут сортировка
    }, {
        "COLUMN_NAME": "id",
        "COLUMN_DEFAULT_VALUE": ,
        "IS_NULLABLE": "NO",
        "DATA_TYPE": "int",
        "CHARACTER_MAXIMUM_LENGTH": ,
        "NUMERIC_PRECISION": 10,
        "NUMERIC_SCALE": 0,
        "COLUMN_KEY": "PRI",
        "EXTRA": "auto_increment",
        "COLUMN_COMMENT": "Идентификатор",
        "REFERENCED_COLUMN_NAME": ,
        "REFERENCED_TABLE_NAME": ,
        "ORDER": 50 // тут сортировка
    }
...

Установка колонки по умолчанию

Для указания колонки по умолчанию применять:

[e100|d] Раздел1

В этом случаи для таблицы будет указан следующий параметр

{
    "TABLE_NAME": "application_projects",
    "TABLE_TYPE": "BASE TABLE",
    "TABLE_TITLE": "Тип приложения",
    "PRIMARY_KEY": "id",
    "TABLE_COMMENT": '',
    "DEFAULT_PROPERTY": "name"
...

, а для колонок будет указана следующая информация

...
        "REFERENCED_COLUMN_NAME": "id",
        "REFERENCED_TABLE_NAME": "sys_users",
        "ORDER": 90,
        "REFERENCED_DEFAULT_PROPERTY": "name"
...

Правила переопределения шаблонов — утилита file-merge

git clone git://git.appcode.pw/file-merge.git

Специальные комментарии

  • //#UPDATE — помечается начало обновления
  • //#UPDATEEND — помечается завершение обновления
  • //#ADD — помечается начало добавления
  • //#ADDEND — помечается завершение добавления

Пример обновления данных

Оригинал:

Ext.define('PN.model.accesses', {
    extend: 'Ext.data.Model',
    idProperty: 'id'
    ...

В оригинальном файле нам требуется убрать свойство idProperty. Наличие пустой строки обязательно, т. к. таким образом сообщается, сколько строк нужно обновить.

Ext.define('PN.model.accesses', {
    extend: 'Ext.data.Model',
    //#UPDATE

    //#UPDATEEND
    ...

В оригинальном файле нам требуется обновить свойство idProperty

Ext.define('PN.model.accesses', {
    extend: 'Ext.data.Model',
    //#UPDATE
    idProperty: 'LINK'
    //#UPDATEEND
    ...

Пример добавления данных

Оригинал:

Ext.define('PN.model.accesses', {
    extend: 'Ext.data.Model',
    idProperty: 'id'
    ...

Требуется добавить еще одно свойство.

Ext.define('PN.model.accesses', {
    extend: 'Ext.data.Model',
    idProperty: 'id'
    //#ADD
    displayProperty: 'table_name',
    //#ADDEND
    ...

Или добавить новую функцию

    validators: {
        user_id: 'presence',
        roles_id: 'presence',
        table_name: { type: 'length', max: 255 }
    }
    //#ADD
    , fio: function () { // '''тут запятая должна находиться именно здесь'''

    }
    //#ADDEND
});

Принудительная генерация и запрет

Для принудительной перегенерации файла требуется указать в начале файла

//#overwrite
Ext.define('PN.model.accesses', {
    extend: 'Ext.data.Model',
    idProperty: 'id'
    ...

Для отмены перезатирания данных указывать в начале файла

//#not overwrite
Ext.define('PN.model.accesses', {
    extend: 'Ext.data.Model',
    idProperty: 'id'
    ...

Запуск node js приложения на iis

Установка Node Js
1.Устанавливаем nodejs https://nodejs.org/en/ (ставить последнюю LTS версию)
2.https://github.com/tjanczuk/iisnode — от сюда устанавливаем расширение для iis (см. Installing for IIS 7.x/8.x)

Настройка IIS

1. https://www.iis.net/downloads/microsoft/url-rewrite устанавливаем расширение для iis

2. Перезагрузить сервер

Статьи:

https://www.hanselman.com/blog/InstallingAndRunningNodejsApplicationsWithinIISOnWindowsAreYouMad.aspx

https://tomasz.janczuk.org/2013/01/hosting-socketio-websocket-apps-in-iis.html

Отладка в nodejs

Актуально для версии Node JS 8.9.0

Устанавливаем:
npm install —global node-inspect

Выполняем команду: node —inspect-brk [filename].js

Должен открыться chrome для начала отладки

Полезные статьи.

https://nodejs.org/en/docs/inspector

https://nodejs.org/api/debugger.html

https://github.com/nodejs/node-inspect