Typical Angular Spring web application setup

Данный репозиторий содержит проект-болванку CRUD вэб-приложения в стеке:

Backend:

1. Spring: Boot, MVC, Data, Security
2. Hibernate
3. H2 Database c диалектом PostgreSQL

Frontend:

1. Angular (Первый)
2. Bootstrap
3. Google Maps API v.3

Сборка:

• gradle

Приложение реализует:

1. Базовую парольную анутификацию
2. Простейшую авторизацию на основе ролей
3. Возможность создания объектов на картах Google и сохранения их в базе данных

Subtle moments of set up

Создание проекта Тут ничего сложного, открываем Intellij IDEA. Выбираем создать новый проект -> Gradle -> Отмечаем java, web.

В мастере важно отметить следующие галочки:

• Use auto-import
• Create directories for empty content roots automatically
• Use default gradle wrapper

После создания проекта помечаем папку src как Sources root, а папку test как Test sources root.

Дальше открываем терминал (Alt + F12) и инициализируем git-репозиторий: git init Через Ctrl + Alt + A добавляем нужные файлы под контроль версий.

Ну и:

    git commit -m "Initial commit"
    git remote add NgSpringIngot https://github.com/aleksey-v-kutergin/ng-spring-ingot.git
    git NgSpringIngot -f origin master

Можно работать дальше :) Я оставляю градле-враппер под контролем версий чтобы приложение всегда можно было собрать без gradle и IDE из консоли.

Типы зависимостей в грэдле:

• compile - зависимости, необходимые во время компиляции проекта
• testCompile - зависимости, необходимые для компиляции тестов
• provided - зависимости, необходимые во время компиляции проекта, но не поставляетмы вместе с war (предполагается их наличие внутри web-контейнера)

Управление зависимостями в gradle

Основная проблема заключаеться в управлении версиями всефозхможных составляющих Spring так, чтобы одно не конфликтовало с другим, включая транзитивные зависимости. Я знаю что есть Spring Boot, но существование вэб-приложения в виде исполняемого jar в контексте энтерпрайза не очень. У заказчика на одном томкате может курутится не одно приложение.

Пойдем немного другим путем. В мавене есть концепция bom-файлов (bill of materials) - это специальный вид pom-файла, который используется для управления версиями зависимостей проекта и предаставляет единый механизм задания и обновления версий зависимостей.

Губо говоря, bom это своего рода родительский pom-файл, который используется для пресета, позволяя кофигурировать:

• Версию java и другие свойства
• Версии ряда зависимостей проекта
• Дефолтная конфигурация плагинов

Собственно, в Spring Boot это выглядит следующим образом:

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.0.RELEASE</version>
    </parent>

Раскруиваем цепочку дальше... Помник Spring Boot Dependencies определяет дефолтный менеджмент зависимостей для всех Spring Boot проектов (пример):

    <properties>
        <activemq.version>5.13.4</activemq.version>
        ...
        <ehcache.version>2.10.2.2.21</ehcache.version>
        <ehcache3.version>3.1.1</ehcache3.version>
        ...
        <h2.version>1.4.192</h2.version>
        <hamcrest.version>1.3</hamcrest.version>
        <hazelcast.version>3.6.4</hazelcast.version>
        <hibernate.version>5.0.9.Final</hibernate.version>
        <hibernate-validator.version>5.2.4.Final</hibernate-validator.version>
        <hikaricp.version>2.4.7</hikaricp.version>
        <hikaricp-java6.version>2.3.13</hikaricp-java6.version>
        <hornetq.version>2.4.7.Final</hornetq.version>
        <hsqldb.version>2.3.3</hsqldb.version>
        <htmlunit.version>2.21</htmlunit.version>
        <httpasyncclient.version>4.1.2</httpasyncclient.version>
        <httpclient.version>4.5.2</httpclient.version>
        <httpcore.version>4.4.5</httpcore.version>
        <infinispan.version>8.2.2.Final</infinispan.version>
        <jackson.version>2.8.1</jackson.version>
        ....
        <jersey.version>2.23.1</jersey.version>
        <jest.version>2.0.3</jest.version>
        <jetty.version>9.3.11.v20160721</jetty.version>
        <jetty-jsp.version>2.2.0.v201112011158</jetty-jsp.version>
        <spring-security.version>4.1.1.RELEASE</spring-security.version>
        <tomcat.version>8.5.4</tomcat.version>
        <undertow.version>1.3.23.Final</undertow.version>
        <velocity.version>1.7</velocity.version>
        <velocity-tools.version>2.0</velocity-tools.version>
        <webjars-hal-browser.version>9f96c74</webjars-hal-browser.version>
        <webjars-locator.version>0.32</webjars-locator.version>
        <wsdl4j.version>1.6.3</wsdl4j.version>
        <xml-apis.version>1.4.01</xml-apis.version>
    </properties>

Как можно заметить из примера выше, Spring Boot Dependencies содержат большую часть зависимостей, необходимых для создания типичного Spring web-проекта. Версия любой зависимости может быть переопределена в помнике проекта. BOM Spring Boot Parent Starter наследует (объявляет как родительский) от Spring Boot Dependencies, а также пресетить ряд плагинов, версию java, кодировку и другое. Таким образом использование бома Spring Boot Parent Starter позволяет легко определить версии зависимостей.

Схема такова:

1. Заюзать Spring Boot Parent Starter
2. В секции dependencies указываем зависиомти, зависимости входящие в bom, без версий.

Использовать механизм bom-ов в системе сборки gradle позволяет dependency-management-plugin.

Применяем плагин:

    buildscript {
      repositories {
        jcenter()
      }
      dependencies {
        classpath "io.spring.gradle:dependency-management-plugin:0.5.1.RELEASE"
      }
    }
    
    apply plugin: "io.spring.dependency-management"

Импортирем bom:

    dependencyManagement {
      imports {
        mavenBom 'io.spring.platform:platform-bom:1.1.1.RELEASE'
      }
    }

Профит:

    dependencies {
        compile 'org.springframework:spring-core'
    }

В чем отличе от Spring Boot plugin: этот плагин тоже позволяет использовать зависимости без версий, но не влияет на транзитивные зависимости. Начиная с Spring Boot 1.3, вместо pring Boot plugin использует dependency-management-plugin. Для более ранних версий, они могут сосуществовать.

Полезные ссылки по теме:

1. Better dependency management for Gradle
2. Introduction to Spring Boot Starter Parent

Запуск приложения на томкате:

Последовательность действий относительно Intellij IDEA: 0. Ставим томкат на локальную машину

1. Идем Run -> Edit Configurations... -> + -> Tomcat Server -> Local -> Виззард открывается
2. Здаем путь до томката, если сам не подхватился \ порт \ версию JRE
3. Идем на владку Deployment и добавляем артефакт (идея сама предложит через кнопку Fix). Нужно выбрать war (exploded). Типа развернутый.
4. Вовращаемся на вкладку Server и в поляк On Update Action \ On Frame deactivation выбрать Update classes and resources
5. Ну и на before build должен быть задан гредловый такск сборки проекта

Пункты 3.,4. активируют так называемый режим хот свапа, при котором фронт и часть бека (контроллеры) редеплоятся автоматом при измении их кода. В купе с watch ангуляра и отладчиком javascript идеи, это все позволяет организовать очень эффективную работу. Томкат приходится перезапускать только при измениях в сервисах и доменном слое, БД. Это все работает только в случае с exploded варником.

Как добавить AngularJS в проект

Почему AngularJS - его проще засунуть в проект чтоб сейчас не тратить сейчас много времени на настройку. По AngularJS 2.0 сделаю отдельный проект.
Можно пойти простым путем... Заюзать ng-boilerplate. Но он сконфигурирован на все случаи жизни и тянет за собой очень много лишнего. Можно его конечно проредить, но это не просто. Проще добавить все минимально необходимое самому:

1. На машине нужно установить node.js (npm ставится с ним)
2. Ставим менеджер зависимостей bower: npm install bower (Вроде бы нынче нужно мигрировать на Yarn)
3. Добавляем в проект package.json - в нем будут описаны всякие зависимости для разработки + команды запуска
4. Добавляем в проект файл bower.json - внем описваются чисто зависимости фронта и .bowerrc.json - настроки самого боувера (в нем также если что надо задавать настроки прокси).
5. Завсисимости фронта будут жить в папке webapp\vendor - она должна быть в .gitignore, чтоб не индексировалось
6. Само ангуляр приложение в папке webapp\app
7. Статика (css, fonts, img, js - напрмер скрипты, необходимые для работы дизайна): webapp\assets\css|fonts|img|js

Больше особо и ничего не нужно. Есть еще много чего: юнит тесты для фронта (karma), интеграционное тестирование... но пока не до этого. Поставить все можно выполнив npm install.

Правильная настрока адресации приложения

Допустим имя варника нашего приложения: ng-spring-ingot.war Имеем две следующих ситуации:

1. Разворачивание приложения на отлельно стояещем томкате Томкат разворачивает варник в одноименную папку. То есть мы получаем путь: webapp(ROOT)\ng-spring-ingot. Для того чтобы приложение могло загрузить все ресурсы и скрипты, прописанные в index.jsp, необхомо указать в index.jsp базовую ссылку: <base href="/ng-spring-ingot/">.

2. Разворачивание приложения на томкате из-под среды разработки (Intellij IDEA). В этом случае приложение по умолчанию разворачивается не в папку ng-spring-ingot, а напрямую в рут (то есть прямо в webapp). Если при этом задан <base href="/ng-spring-ingot/">, то приложение ничего не найдет. Чтобы подружить оба случая, нужно зайти в конфигурацию запуска на вкладку Deployment и задать значение /ng-spring-ingot"> в поле Application context.

При выполнении п.1 и п.2 все будет работать и так и сяк :)

Подключение встроенной базы H2 в Spring MVC приложение

В общем, в случае со Spring Boot все просто. Большая часть всей конфигурации выполняется автоматически. H2 база с вэб-консоль в Spring Boot идут по дефолту. На сколько я понял Spring Boot, весь дефолтный конфиг можно перенастроить через application.properties при помощи изменения значений пропертей. Например, параметры источника данных:

    spring.datasource.url=jdbc:h2:mem:db1;MODE=PostgreSQL
    spring.datasource.driverClassName=org.h2.Driver
    spring.datasource.username=sa
    spring.datasource.password=

А для активации h2 консоли в Spring Boot достаточно добавить в application.properties две строчки:

    #spring.h2.console.enabled=true
    #spring.h2.console.path=/h2

А также через переопределение бинов. Как я уже писал, Spring Boot это круто, но далеко не всегда удобно.

Поэтому попытаемся все сделать для SpringMVC приложения. Первое, что для этого нужно - наличие h2 базы в класспасе:

    compile group: 'com.h2database', name: 'h2'

В принципе с самой H2 базой все... Основные папраметры ее работы передаются через database url:

    jdbc.datasource.url=jdbc:h2:mem:ngSpringIngotDB;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE

где

• DB_CLOSE_DELAY=-1 - означает
• DB_CLOSE_ON_EXIT=FALSE - означает

Также, важными являются следующие настройки хибера:

    jpa.hibernate.hbm2ddl.auto=create-drop
    jpa.hibernate.dialect=org.hibernate.dialect.H2Dialect

где

• hbm2ddl.auto=create-drop - хибер грохает схему данных когда бин SessionFactory останавливает свою работу явно

Все остальные развлечения были с тем чтобы запустить вэб-консоль H2 базы. Внимание, ключевой момент! Чтобы это сделать в рамказ Spring MVC приложения, необходимо зарегистрировать в контесте сервлет для консоли и прописать маппинг!!! То есть, в методе onStartup(...) класса SpringWebAppInitializer нужно прописать:

    ServletRegistration.Dynamic h2Console = servletContext.addServlet("h2Console", new WebServlet());
    h2Console.setLoadOnStartup(2);
    h2Console.addMapping("/admin/h2/*");

где WebServlet - org.h2.server.web.WebServlet.

Также есть еще альтернативный вариант через создание бина сервера:

    @Bean(initMethod="start",destroyMethod="stop")
    public org.h2.tools.Server h2WebConsonleServer () throws SQLException {
        return org.h2.tools.Server.createWebServer("-web","-webAllowOthers","-webDaemon","-webPort", "8082");
    }

Как показал эксперимент, для работы системы следующие джарник и бомы не требуются:

    compile group: 'org.springframework.boot', name: 'spring-boot-devtools'
    mavenBom 'org.springframework.boot:spring-boot-starter-web:1.5.1.RELEASE'
    mavenBom 'org.springframework.boot:spring-boot-starter-data-jpa:1.5.1.RELEASE'

Возможно бомы потреюбуются где-то в дальнейшем, но пока что для работы приложения достаточно бома: org.springframework.boot:spring-boot-starter-parent:1.5.1.RELEASE.

Для чего нужны были заморочки с консольлю??? База живет в памяти и создается в рантайме, поэтому неплохо было бы иметь инструем для просмотра результатов генерации базы и работы persistence-слоя приложения. На этом вроде все.

Дальше удобно бы было создать таблицы и наполнить некоторые из них данными (например таблицу пользовтелей). Поидее можно этого не делать. Хибер может прогенерить схему на освен маппинга, но это не тру :)

Чтобы созать таблицы и заполнить их данными при помощи скриптов из папки resources (ресурсы из classpath) необходмы создать "наполнитель" источника данных и применить его к источнику:

    ResourceDatabasePopulator populator = new ResourceDatabasePopulator();
    populator.setContinueOnError(false);
    populator.addScript(new ClassPathResource("dbschema.sql"));
    populator.addScript(new ClassPathResource("data.sql"));
    DatabasePopulatorUtils.execute(populator, dataSource);

Все необходмые классы лежат в пакете org.springframework.jdbc.datasource.init. Важный момент sql-ники не должны быть пустыми! Иначе получите исключение при запуске.

Дальше идут стандартные настроки: создание бинов датасорса, фабрики сущностей, и манагера транзакций. Поднимаем маппин, добавляем JPA-репозитоии и в перед. Единственное со Spring Security и консолью H2 бызы есть заморочки, о которых можно прочитать здесь: Configuring Spring Boot for the H2 Database Console

Полездные ссылки по теме:

• Очень полезно!!! -> How to use H2 embeded database in spring application
• How to connect H2 console to embedded Spring H2 DB
• spring boot default H2 jdbc connection (and H2 console)
• DatabasePopulator