необходимо перенести ваше crud приложение на spring boot
Перенесите существующее приложение spring в spring-boot, вручную настройте spring-boot?
У меня есть существующее приложение spring 3.1.4, которое отлично работает и загружается самостоятельно. В настоящее время я запускаю весенний контекст вручную в своем основном классе. Это не приложение spring-mvc, оно не содержит сервлетов, web.xml также не порождает войну. Он просто производит банку для бэкэнда интеграции.
Я хотел бы «обернуть» это устаревшее приложение и запустить его с spring-boot. Однако мне трудно понять, как это сделать, поскольку все примеры кажутся предполагать создание» нового » приложения.
1) у меня есть существующий applicationContext.xml-файл с моими существующими объявлениями Spring app bean в нем
2) каков минимальный набор новых конфигураций bean, которые мне нужно добавить в существующий Spring applicationContext.xml-файл, чтобы запустить spring-boot w/ tomcat и загрузить все мои существующие бобы в контекст spring-boot?
может кто-нибудь указать мне в правильном направлении, пожалуйста?
1 ответов
есть глава, посвященная преобразование существующего приложения в Spring Boot в справочном руководстве Spring Boot.
в основном вам нужно добавить зависимости загрузки Spring, а затем реализовать основную точку входа следующим образом:
однако это также вызовет автоматическую конфигурацию Spring Boot на основе (среди прочего) доступных классов и настроенных компонентов. Возможно, вы захотите отключить определенные авто-конфигурации. Чтобы исключить источник данных и гибернацию JPA auto-configuration, используйте:
Публикация Spring Boot приложения в GitHub Packages с помощью GitHub Actions для самых маленьких
Сегодня я расскажу вам как можно опубликовать своё Spring Boot приложение в GitHub Packages с помощью GitHub Actions. Вот так. В общем-то всё. Вот. Спасибо за внимание.
Ну, а здесь, для самых любознательных, приведу немного информации о том, что делает этот GitHub Action.
Старт
Прежде чем перейти к самому GitHub Action приведу сначала то, что он должен уметь делать.
Он должен собрать докер образ.
Выложить его в GitHub Packages.
В качестве примера собирать буду вот этот проект. Подробнее о нём я писал в этой статье. Здесь лишь отмечу, что в качестве системы сборки в нём используется gradle.
Сборка docker-образа
Как же можно собрать docker-образ своего приложения? Ну конечно же, написать Dockerfile! Делать я этого, конечно же, не буду, а воспользуюсь замечательным проектом Cloud Native Buildpacks.
Что же в этом проекте такого замечательного. В Spring Boot имеется поддержка этого проекта, что позволяет собрать docker-образ без написания Dockerfile всего одной командой. Например, при использовании в качестве сборщика gradle это команда будет выглядеть так:
В результате выполнения команды будет создан и локально опубликован docker-образ. Версия java определиться автоматически из настроек сборщика, а в качестве JDK по умолчанию будет использоваться сборка BellSoft Liberica.
Параметры по умолчанию можно изменить. Как это сделать можно посмотреть в настройках плагина для соответствующей системы сборки (maven, gradle). Возможно, через конфигурацию плагинов получится изменить не все параметры, которые есть в buildpack. В этом случае собирать образ можно будет с помощью утилиты pack. Подробнее о сборке java приложений с помощью этой утилиты можно почитать, например, тут. Правда, на мой взгляд, это будет уже не так лаконично, как было с помощью соответствующих плагинов.
Немного о возможных проблемах
Изначально в проекте у меня была java 15. Но при вызове таски bootBuildImage я получал ошибку вида:
Как оказалось, ошибка была связана с тем, что у BellSoft нет сборки java 15. Но когда-то она была, но после того как они собрали 16-ю версию, 15-ю решили удалить. И это выглядит, мягко говоря, не очень надёжным. Ну и с выходом 17-й так же удалили и 16-ю.
Сборка и публикация через GitHub Actions
Немного о GitHub Actions. Это штука, которая позволяет автоматизировать рабочий процесс прямо в GitHub (настроить CI/CD). Например, с помощью неё можно собирать приложение по коммиту, где-то публиковать, прогонять тесты и делать многое-многое другое.
После этого мы перейдём на страницу создания нового action для проекта, на которой уже будет доступен код, который можно редактировать.
Немного разберём что здесь происходит.
Изменим скрипт таким образом чтобы он делал требуемые нам действия. В результате получится так.
Разберём что изменилось.
Немного о правах GITHUB_TOKEN
GITHUB_TOKEN не всесилен. Его набор прав ограничен из коробки. Но его можно расширить с помощью блока permissions.
Так же, например, правами на packages можно управлять на странице настроек пакета (думаю, другими правами так же можно управлять на соответствующих страницах).
На этой странице в блоке Manage Actions access можно добавлять репозитории и давать им права на этот пакет. И если, например, дать права только на чтение репозиторию, то он не сможет с GITHUB_TOKEN сюда публиковать, не смотря на то что у GITHUB_TOKEN по умолчанию есть доступ на запись.
Заключение
Вот, в общем-то, и всё. Надеюсь, было интересно и полезно. Берегите там себя.
Spring Boot REST API
В этой статье мы напишем маленькое приложение на Spring Boot, которое предоставляет REST-сервисы.
Архитектура приложения будет стандартна и включать несколько слоев: dao, (service отсутствует) и controller. Все шаги по построению приложения просты. Код приложения можно скачать на GitHub.
Spring Initializr
Заготовку любого проекта на Spring Boot удобно взять на https://start.spring.io/. Здесь мы придумываем имя группы и имя артифакта будущего проекта на Maven, выбираем dependency, которые нам точно понадобятся и генерируем проект. А потом импортируем его в Eclipse как Maven-проект.
Инициализация Spring Boot проекта
Нам понадобятся зависимости WEB, JPA и H2.
Встроенную базу данных H2 прикрепляем потому, что ее проще использовать для демонстрационных целей: не придется устанавливать настоящую базу вроде MySQL, а также прописывать ее настройки.
Maven-зависимости
В результате получаем сгенерированный POM с такими зависимостями:
Хоть файл и сгенерирован, это не мешает нам добавлять в него новые зависимости при необходимости.
Слои (multi-layer architecture)
Импортированный проект выглядит так, плюс мы создали пакеты для моделей, dao и контроллеров (выделены красным):
Service-layer отсутствует потому, что приложение слишком простое, бизнес-логики тут нет.
Модель
Модель будет состоять из одного класса Person:
Person аннотирован как JPA-сущность, то есть при запуске приложения в базе данных будет создана таблица с таким именем и полями.
DAO-layer предназначен для работы с данными. У нас он состоит из одного бина PersonRepository.
Благодаря аннотации @Repository и интерфейсу JpaRepository DAO-layer предельно прост:
Мы создаем бин PersonRepository, аннотируя его с помощью @Repository. Полученный бин реализует все методы интерфейса, можно ничего не писать самостоятельно, если не нужны какие-то особые запросы к базе. А стандартные операции поиска, добавления и удаления тут все реализованы.
Service-layer опускаем, поскольку приложение простое. В контроллере будем использовать бин PersonRepository.
Контроллер
Здесь реализованы запросы поиска, добавления, редактирования и удаления Person.
Тут два метода для получения данных (аннотации @GetMapping) и три — для редактирования. Все методы аннотированны:
Возвращаем обычно ResponseEntity
, это более гибкий вариант, чем вернуть просто Person, поскольку для ResponseEntity можно установить Http-статус ответа — ResponseEntity.ok() — это 200 или ResponseEntity.status(201).
В методе body() передается возвращаемая сущность — в вышеприведенных методах это Person (либо список Person). Под капотом она конвертируется в JSON благодаря тому, что у нас стоит аннотация @RestController. Для конвертации под капотом Spring Boot использует библиотеку Jackson — она включена благодаря Maven-зависимости spring-boot-starter-web.
Если надо возвратить JSON с описанием ошибки, выбрасываем исключение. Например, если запрос на редактирование содержит id несуществующего Person, то выбрасываем EntityNotFoundException. Как обрабатывать исключения и кастомизировать JSON с ошибкой, описано в следующей статье.
Запуск
Для запуска Spring Boot приложения запускаем main() этого класса:
При этом будет запущен веб-сервер, отдельно его устанавливать и запускать не надо — это одно из преимуществ Spring Boot приложения.
Также не надо задавать пути для поиска бинов, они найдутся автоматически. Единственное, класс SpringBootRestApplication не надо перекладывать в подпакет, он должен быть на верхнем уровне иерархии, иначе с поиском бинов возникнут проблемы. Когда мы сгенерировали заготовку приложения, этот файл уже был именно там, где надо — перекладывать его не следует.
Тестирование
Осталось проверить, что методы контроллера работают. Составлять запросы будем с помощью бесплатного графического приложения Postman. Как писать тесты, рассмотрим в другой статье.
Добавление Person
Ответ, возвращается вновь добавленный Person с >
Редактирование Person
Ответ, возвращается отредактированный Person с и name=’Jane’:
Получение Person
Ответ, возвращается Person:
Получение списка Person
Ответ, возвращается список, состоящий из одного элемента Person:
Удаление Person
Ответ, возвращается удаленный Person с и name=’Jane’:
Заключение
Мы написали маленькое приложение, предоставляющее REST-сервис. Как обрабатывать исключения описано в следующей части.
Spring Boot REST API: 7 комментариев
Есть ли статья по тестированию?
Будет в ближайшее время
Аесть статья, как кастомизировать response body таким образом, чтобы в нем можно было возвращать не все поля энтити? Например, я хочу исключить из респонза ID. Мне на ум приходит два варианта, оба убогие.
1. В теории, я могу сделать ResponseEntity и исключить из переопределения toString нужное поле, но я не хочу возвращать стринг, я хочу вернуть именно json. Есть возможность дефолтными методами это как-то сделать или необходимо только всякие манипуляции проводить с кастованием стрингов в жсон и обратно?
2. Кастомизировать Query, чтобы он возвращал только нужные поля. Но тогда возвращаемым значением будет Object, которые никак не получится кастовать к моему классу. Да и работать с таким значением невозможно.
1. Заботиться о преобразовании в объекта в JSON не надо, это на совести контроллера. Главное, чтобы у нас был объект с нужными полями.
2. Чтобы он был, надо использовать паттерн DTO — Data Transfer Object; то есть помимо объекта Person, создаете объект PersonDTO специально для передачи — он содержит ровно те поля, которые нужно отправить/принять на фронтенд.
В статье этого нет, т.к. случай рассмотрен примитивный. Но если бы было, возвращаемым значением метода getPerson()был бы:
Spring Boot: от начала до продакшена
В данной статье я попробую расписать все шаги, которые потребуются для создания небольшого проекта на Spring Boot и развертывания его на боевом сервере.
Не будем тянуть долгими прелюдиями о философии java и spring’а, и сразу приступим к делу.
Для начала нам необходимо создать каркас приложения, внедрив туда весь необходимый зоопарк технологий(как минимум Spring, JPA, JDBC). До появления spring boot нужно было потратить на это немало времени, если конечно у вас не было рабочей заготовки в закромах кода. И именно сложность создания подобного каркаса, как мне кажется, останавливает многих от разработки небольших веб-проектов на java. Конечно, когда-то был хромой spring roo, который мог создать подобный каркас в ущерб производительности(привет аспектам), но даже с ним количество и сложность конфигурационных файлов заставляли долго медитировать над ними неподготовленного разработчика. Однако теперь с приходом Boot и Spring 4 жизнь стала немного проще и количество конфигурационных файлов заметно уменьшилось.
Если же у вас нет данной IDE, то скачиваем Spring Boot CLI, следуем инструкции в INSTALL.txt. Нужно задать системную переменную SPRING_HOME(путь к папке со Spring Boot, не к папке bin!) и добавить путь к SPRING_HOME/bin в системную переменную PATH на windows.
Итак, консоль спринга настроили, теперь самое время создать проект. Сделать это можно следующей командой:
UPDATE
Кроме того, как написали в комментариях, существует еще веб-конструктор: start.spring.io
Далее импортируем получившийся каркас в любимую IDE и начинаем его модифицировать под наши нужды.
Для начала добавим в каталог src/main папку webapps. Все веб-ресурсы мы будем создавать в ней, а не в папке resources, как хочет того спринг. Дело в том, что если мы будем создавать файлы в папке resources, то тогда мы лишимся возможности видеть изменения, сделанные в наших веб-ресурсах, без перезагрузки сервера. А это может быть неприятно, когда ради того, чтобы посмотреть изменившийся текст на веб-странице приходится перезапускать веб-сервер.
Теперь в папке webapps создаем файл index.html и папки css, js, font, images, в которые будем класть соответствующие ресурсы.
Для примера сделаем самый простой каркас index.html:
Изменим файл pom.xml
Должно получиться что-то подобное:
Из pom-файла мы можем увидеть следующее:
Мы используем java 8(самое время ее попробовать). Наш класс приложения называется com.yourcompany.Application(не забудьте переименовать стандартно сгенерированный класс, который может называться к примеру DemoApplication).
Мы используем postgresql 9.4(тоже неплохо бы установить его локально на свою машину). Connection pool для взаимодействия с базой данных мы берем самый модный и производительный (HikariCP). Кроме того, мы используем специальный плагин, который, когда мы будем генерировать итоговый jar’ник, перенесет все наши данные из webapp в resources/static, как того хочет spring boot. В противном случае вы не сможете увидеть все те веб-страницы, что создадите в папке webapps, когда запустите jar-ник.
Добавим пакет config и создадим в нем класс JpaConfig:
Кроме того, добавим в файл application.properties следующие строчки:
И наконец в Application.java меняем строку инициализации на следующую:
Тем самым мы настроили подключение к СУБД PostgreSQL.
Не забываем создать саму базу данных и простенькую таблицу в ней. Сделать это удобнее всего через PgAdmin.
Создав в ней пустую базу yourapp_data, выполняем скрипт создания таблицы:
Теперь настало время немного заняться начинкой нашего проекта. А именно добавить какую-нибудь сущность БД и научиться с ней работать, получая с клиента данные для ее формирования и отправляя клиенту же данные об уже созданных сущностях.
Создаем пакеты controller, entity, repository, service, utils.
В пакете entity создаем интерфейс:
Аннотации JPA и Hibernate в данном примере использовать не будем, так как эти технологии сильно замедляют работу(запрос может выполняться в 10 раз медленнее, чем на чистом jdbc), а так как у нас нет сильно сложных сущностей, для которых реально может потребоваться ORM, то воспользуемся обычным jdbcTemplate.
Создаем интерфейс репозитория:
Вместо уже упомянутого jdbcTemplate, мы, как видите, используем JdbcOperations, который является его интерфейсом. Нам приходится использовать везде интерфейсы, отделяя их от реализации, так как, во-первых это стильно, модно, молодежно, а во-вторых, spring в нашем случае использует стандартный jdk’шный Proxy для наших объектов, поэтому напрямую инжектить реализацию не получиться, пока мы не введем полноценные аспекты и AspectJ compile-time weaving. В нашем случае этого и не требуется, чтобы не перегружать приложение.
Осталось уже немного. Создаем наш сервис(мы же хорошие разработчики и должны отделить бизнес-логику от логики работы с СУБД?).
Отлично. Теперь создаем пару вспомогательных классов, необходимых для реализации контроллера:
Это наша реализация Exception’а. Может пригодиться в будущем, хотя и не обязательна, но на нее завязан следующий класс:
Если мы словили такую ошибку в нашем контроллере, то она будет обработана дополнительно в этом методе.
Наконец напишем небольшой классик, который будет формировать структуру данных для передачи на клиент:
Все, со вспомогательными классами закончили. Осталось написать наш контроллер. Он будет простым, как пробка:
В нем два метода — сохранить полученные данные и выдать порцию случайных данных на клиент. Контроллер унаследован от созданного нами ранее ExceptionHandlerController. Обработка исключений написана только как шаблон и нуждается в соответствующей доработки под себя.
Итак, основная часть серверного кода написана, осталось проверить его работу на клиенте. Для этого нужно доработать наш файл index.html и заодно добавить библиотеку jquery в каталог js.
index.html:
Да, UI получился не бог весть каким красивым, но зато с его помощью мы можем проверить работу приложения.
Запустим наш проект. В Intellij Idea это можно сделать через специальную конфигурацию запуска(Spring Boot).
Если все сделано верно, то по адресу localhost:8080 вы сможете увидеть заголовок Hello World, строку ввода и две кнопки. Попробуйте ввести что-нибудь в строку ввода и нажать на кнопку POST. Если после этого вы увидите аналогичный текст ниже поля ввода, то все работает как надо. Теперь останется модифицировать проект под свои нужды, добавить модный UI(например materializecss.com) и творить разумное, доброе, вечное.
Однако рано или поздно вы сотворите желаемое и встанет вопрос о том, как донести ваше детище в массы. Об этом будет вторая часть статьи.
Начнем с малого, но важного.
Даже если проект небольшой, все равно для него потребуется свой домен. Если вы просто обкатываете какую-нибудь идею и не хотите тратить бешеные деньги для регистрации домена на том же godaddy, то можете воспользоваться бесплатной альтернативой: freenom.com
Далее займемся сервером, где все это будет крутиться. Так как проект у нас небольшой, то и сервер нам сгодится небольшой. В идеале хватит VPS. Достать его можно в разных местах, например www.digitalocean.com
Итак, регистрируемся, создаем самый простой дроплет и ставим на него ubuntu (в моем случае это ubuntu 12.04, дальнейшие инструкции буду описывать для этой системы, но на остальных будет примерно то же)
Отлично, у нас есть сервер, пора залить на него наш проект.
Но не будем унывать, поставим себе новую версию:
Теперь настала очередь postgres’а. До этого мы использовали локальную версию на машине разработчика, теперь пришло время поставить СУБД на сервер.
Для этого сначала выполняем магическую последовательность команд:
Далее выполняем команду входа в psql:
И выходим c помощью команды \q
Редактируем файл /etc/postgresql/9.4/main/postgresql.conf, изменив строчку #listen_addresses = ‘localhost’ на listen_addresses = ‘*’
Тем самым мы сможем подключаться к postgresql извне с помощью pgadmin’а. Хотя, конечно, желательно этого избежать в целях безопасности, и когда все будет настроено и отлажено, отключить эту возможность.
Затем редактируем файл /etc/postgresql/9.4/main/pg_hba.conf
Должны быть добавлены две новых строчки и изменена одна строка для 127.0.0.1 следующим образом:
Я намеренно изменил md5 на trust, так как лично у меня были проблемы с запуском проекта, тем самым отключив проверку пароля для заданных адресов. Возможно у вас их не будет.
Теперь все настроено. Хотя тюнинговать постгрес можно до бесконечности, но ведь у нас всего лишь маленький проект, а значит, пока оставим как есть.
Перезапускаем postgres: и проверяем его работу.
Всё, с настройкой postgres’а закончили, что у нас дальше по сценарию?
В моем случае корневой директорией nginx была /etc/nginx. Там нам в первую очередь потребуется изменить файл /sites_available/default следующим образом:
Однако и это еще не все. Необходимо также модифицировать наш проект, чтобы он поддерживал настроенный нами прокси. Благо сделать это не трудно, достаточно лишь в application.properties добавить строки(не забудьте залить новую версию с изменениями):
Теперь можно запустить nginx командой service nginx start и затем попробовать запустить наш проект. Он будет доступен по ссылке сайта, либо же, если вы еще не приобрели домен, то по его ip-адресу, без указания порта.
Остался еще один небольшой штрих. Немного неудобно всегда стартовать проект тем способом, который был описан выше. Неплохо бы, чтобы при старте проекта консоль ввода на сервере освобождалась, приложение не закрывалось бы после выхода из ssh-сессии и чтобы где-нибудь велись логи приложения. Сделать это можно с помощью команды nohup. Предварительно создаем bash-скрипт, называя его script.sh:
Прописываем ему право на исполнение:
И запускаем командой:
Все, приложение запущено.
Теперь, если все сделано правильно, можно открыть сайт нашего проекта в браузере и насладиться результатом.
Пример Spring Boot & Angular 5 & Spring Data & Rest (CRUD)
Это руководство предоставляет полную реализацию Spring Boot, Angular 5 и данных Spring для построения сквозного одностраничного веб-приложения Java с примером. Мы будем использовать Spring Boot 1.5 для предоставления API-интерфейсов REST и Angular5 с маршрутизацией для построения нашего клиента, который будет использовать API-интерфейсы, предоставляемые сервером. Также мы будем интегрировать базу данных MySql с внутренним кодом для работы CRUD. Мы будем использовать угловой CLI для генерации углового проекта и инициализаторы весенней загрузки для генерации проекта весенней загрузки. В этой статье вы сможете создать приложение для управления пользователями с операцией CRUD, которое можно либо развернуть на автономном tomcat, либо развернуть клиент и сервер на разных серверах с запросами разных источников.
Angular5 Environment SetUp
Если он не установлен, сначала посетите официальный веб-сайт NodeJ, чтобы установить его. Теперь, когда это будет сделано, перейдите к местоположению своего рабочего пространства и выполните следующие команды, чтобы установить anglic cli и создать пример углового проекта.
Как только это будет сделано, вы можете перейти к местоположению и увидеть, что создано приложение-портал, содержащее все файлы и папки, сгенерированные командой angular cli для начала работы с angular 5. Теперь вы можете открыть свой любимый редактор для импорта проекта. Я импортировал этот проект в IntellijIdea и получил структуру, как показано ниже:
Здесь нужно проверить одну вещь: если вы установили NodeJ с помощью команды sudo, то при установке angular cli вы можете получить некоторые проблемы с разрешениями, как показано ниже. Чтобы избежать подобных ситуаций, всегда рекомендуется использовать команду brew при установке любых новых программного обеспечения.
Если вы столкнулись с этой проблемой, предоставьте доступ на чтение / запись к папке — / usr / local / lib / node_modules или следуйте инструкциям здесь — Поддержка Mac
Для пользователей Windows вы можете использовать командную строку git или cygwin для установки.
Spring Boot Environment SetUp
Команда Spring boot действительно упростила настройку среды начальной загрузки, предоставив инициализаторы по умолчанию. Откройте URL https://start.spring.io/ и сгенерируйте проект следующим образом.
Теперь разархивируйте user-portal.zip и импортируйте в Java IDE. Ниже будет окончательная структура.
Файлы по умолчанию, созданные командой CLI
Теперь давайте попробуем разобраться в разных сгенерированных файлах.
Модули — Модули разбивают приложение на логические части кода. Каждый фрагмент кода или модуля предназначен для выполнения одной задачи. Все модули загружаются main.ts.
Компонент — Компонент используется для объединения модулей.
tsconfig.json — Наличие файла tsconfig.json в каталоге указывает, что каталог является корнем проекта машинописного текста. Этот файл определяет корневые файлы и движения компилятора машинописного текста, необходимые для компиляции машинописного текста.
package.json — содержит все зависимости, определенные для углового проекта. Как только мы установим их, эти зависимости загружаются автоматически.
karma.conf.json — файл конфигурации для юнит-тестов кармы.
Теперь пришло время запустить приложение, сгенерированное dfault, и увидеть его в браузере. Если вы используете IntellijIdea, вы можете запустить команду ng serve из Терминала внутри него, а если не нажмете следующую команду в терминале.