nutz-spring-boot-starter

概述

nutz-spring-boot-starter — это плагин, который предоставляет возможность использовать функции nutz в среде spring-boot. Плагин реализуется с помощью механизма автоматической настройки spring-boot и может быть использован после добавления jar. Так просто!

Начало использования

Перед использованием убедитесь, что вы знакомы с разработкой проектов с использованием spring-boot. Этот документ описывает только плагин nutz-spring-boot-starter. Если у вас есть вопросы по spring-boot, обратитесь к https://spring.io/projects/spring-boot.

Добавление зависимостей

Релизная версия nutz-spring-boot-starter была опубликована в центральном репозитории maven. Чтобы добавить зависимость с помощью maven, используйте следующую информацию о зависимости:

<dependency>
	<groupId>org.nutz</groupId>
	<artifactId>nutz-spring-boot-starter</artifactId>
	<version>2.5.1</version>
</dependency>

Снапшоты были опубликованы на https://jfrog.nutz.cn/artifactory/snapshots. Для их использования добавьте следующие настройки репозитория:

<repositories>
	<repository>
		<id>nutz</id>
		<url>https://jfrog.nutz.cn/artifactory/public</url>
	</repository>
	<repository>
		<id>nutz-snapshots</id>
		<url>https://jfrog.nutz.cn/artifactory/snapshots</url>
		<snapshots>
			<enabled>true</enabled>
			<updatePolicy>always</updatePolicy>
		</snapshots>
		<releases>
			<enabled>false</enabled>
		</releases>
	</repository>
</repositories>

Для других инструментов управления зависимостями настройте конфигурацию в соответствии с maven.

Использование dao

После добавления jar-файла и настройки источника данных будет автоматически внедрён объект Dao. Для получения дополнительной информации об использовании nutz-dao обратитесь к https://www.nutzam.com.

Конфигурация

Во время использования можно настроить автоматическое создание и изменение таблиц, а также пользовательские SQL и шаблоны SQL. Подробные инструкции приведены ниже.

Автоматическое создание таблиц

Автоматическое создание и изменение таблиц — это функция автоматического DDL от nutz, которая решает проблему частого изменения кода и определения базы данных во время разработки. Рекомендуется отключить эту функцию в производственной среде, так как она может привести к потере данных из-за удаления таблиц. Конфигурация проекта описана ниже:

nutz:
  dao:
    runtime:
      create: true #создавать ли таблицы по умолчанию
      migration: true #выполнять ли автоматическое изменение
      add-column: true #добавлять ли столбцы
      delete-column: true #удалять ли столбцы
      foce-create: false #удалить ли все таблицы и перестроить их (опасно)
      check-index: true #проверять ли индексы
      basepackage: #пакеты, содержащие сущности
        - org.nutz.demo.bean

Согласно описанию от nutz, все сущности с аннотацией @Table в соответствующих пакетах будут автоматически создавать таблицы. У автоматического создания таблиц есть ограничения:

• Не создаются внешние ключи.
• Решаются только общие задачи создания таблиц. Сложные структуры таблиц должны быть реализованы с помощью пользовательских SQL.
• Из-за сканирования ресурсов spring-boot при упаковке приложения необходимо добавить BOOT-INF.classes перед именами пакетов.

Пользовательский SQL

Nutz.Dao предоставляет большинство простых операций. В более чем 80% случаев вам не нужно писать SQL, потому что Nutz.Dao автоматически генерирует SQL, который вы можете использовать. Однако в некоторых особых случаях, особенно когда речь идёт об эффективности, прямое написание SQL остаётся мощным инструментом для разработчиков, позволяющим им выполнять любые операции с любой базой данных.

Nutz-dao сканирует все файлы .sql/.sqls/.sqlx в каталоге sqls по умолчанию. Настройка и инструкции описаны ниже:

nutz:
  dao:
    sql-manager:
      mode: file #режим управления sql
      paths: #пути к файлам sql
        - sqls

Шаблоны SQL

Шаблоны SQL — это механизм, использующий шаблонизатор для внедрения параметров в исходный SQL перед выполнением. Он похож на динамический SQL в mybatis. В настоящее время поддерживаются BEETL, FREEMARKER, JETBRICK и VELOCITY.

Необходимо самостоятельно импортировать зависимости шаблонизатора и не предоставляется поддержка конфигурации самого шаблонизатора. Настройки и инструкции приведены ниже:

nutz:
  dao:
    sql-template:
      enable: true #включать ли
      type: beetl #тип шаблонизатора, по умолчанию beetl

Использование json

Поддержка JSON использует расширение Spring MVC HttpMessageConverter для сериализации и десериализации объектов. Эта функция включена по умолчанию.

Настройка JSON

Можно настроить формат JSON во время использования. Инструкции приведены ниже:

nutz:
  json:
    enabled: true #включать ли, по умолчанию true
    mode: compact #формат json, по умолчанию compact
    ignore-null: true #игнорировать ли пустые объекты
    compact: true #использовать ли компактный формат
    date-format: yyyy-MM-dd Hh:mm:ss #формат даты
    ... #дополнительные настройки см. в подсказках IDE

Использование nutz http

Nutz http — это встроенный клиент HTTP от nutz. В основном он предоставляет поддержку RestTemplate для клиента nutz http. Настройки описаны ниже:

nutz:
  http:
    enabled: true #включать ли поддержку nutz http client для RestTemplate, по умолчанию true
    http:
      connection-timeout: 5000 #время ожидания соединения http, по умолчанию 30 * 1000
      follow-redirects: true #следовать ли перенаправлениям, по умолчанию true
      jvm-https-check: false #включать ли проверку jvm https сертификата, по умолчанию true
      timeout: 60000 #время чтения, по умолчанию 10 * 60 * 1000
    proxy:
      enabled: true #включать ли прокси (поддерживает только http прокси)
      host: 10.1.1.1 #адрес прокси
      port: 8080 #порт прокси
      proxied-hosts: #список доменов, которые будут проксироваться
      - baidu.com
      - oschina.net

Использование ngrok

ngrok — это инструмент для внутреннего проникновения, предоставляемый https://nutz.cn. Его можно использовать для демонстрации локальных проектов или для отладки общедоступных интерфейсов, таких как API WeChat. Настройки приведены ниже:

nutz:
  ngrok:
    port: 8080 #локальный порт прокси, по умолчанию используется server.port
    token: abcdef #токен ngrok, получите его на https://nutz.cn

Поддержка и обслуживание

За технической поддержкой обращайтесь к автору: kerbores#gmail.com