책으로 보는 개발 세상

JHipster에서 엔티티 생성시 일반적으로 다음과 같은 요소들이 필요하다.

• A database table
• A Liquibase change set
• A JPA Entity
• A Spring Data JPA Repository
• A Spring MVC REST Controller, which has the basic CRUD operations
• An Angular router, a component and a service
• An HTML view
• Integration tests, to validate everything works as expected
• Performance tests, to see if everything works smoothly

엔티티 간 관계가 필요할 시 추가적으로

• A database foreign key
• Specific JavaScript and HTML code for managing this relationship

JHipster가 제공하는 entity sub-generator를 이용하면 위의 요소들을 자동생성 해준다.

•  jhipster entity <entityName> --[options] 

sub-generator에서 사용 가능한 옵션은 jhipster entity --help를 통해 확인해볼 수 있다.

• --table-name <table_name> : entity와 다른 이름으로 테이블을 생성하고 싶을 시. (기본 옵션은 엔티티와 동일한 이름으로 테이블을 생성한다.)
• --angular-suffix <suffix> : 모든 angular router에 접미사를 추가하고 싶을 시.
• --client-root-folder <folder-name> : client side 엔티티들의 루트 폴더 이름 설정.
• --regenerate : entity 재생성.
• --skip-server : client-side 코드만 생성.
• --skip-client : server-side 코드만 생성.
• --skip-db-changelog : Liquibase 에서 change log 생성을 생략.
• --db : server-side를 생략할 때 db

JHipster UML and JDL Studio를 통한 다중 엔티티 생성

(JHipster UML, JDL Studio)

• jhipster import-jdl your-jdl-file.jh.
• jhipster import-jdl ./my-jdl-file.jdl --json-only : .jhipster 폴더에 존재하는 json 파일만 엔티티 생성.
• jhipster import-jdl ./my-jdl-file.jdl --force : import-jdl 옵션은 기본적으로 변경된 엔티티만 재생성함. --force 옵션을 통해 모든 엔티티 재성성.

엔티티 생성시 정보

• Entity fields
  - java나 사용하는 db의 예약어들은 field keyword로 사용할 수 없다. 
• Field types
  - java타입을 기본적으로 사용하고, db종류에 따라 키워드가 변경된다.
• Validation
  - 각각의 필드에 유효성 룰을 추가할 수 있고, 이는 client-side, server-side에 각각 추가 된다.
  (Angular, React, Vue validation / Java Domin object bean validation)
• Entity relationships
  - 엔티티 간 관계 설정
• Generating a separate service class for your business logic
  - 서비스 계층 생성 여부
• Data Transfer Objects (DTOs)
  - 서비스 계층 생성 시 DTO 사용 여부를 선택할 수 있다.
• Filtering
  - JPA를 통한 필터링 옵션을 제공한다.
• Pagination
  - 페이지네이션은 Link header를 이용한다.
  - No pagination(back-end가 페이징 처리되지 않음), pagination(Bootstrap pagination component), Infinite scroll(directive 사용) 3가지 옵션을 제공한다. 

엔티티 업데이트

- sub-generator에 이미 생성 된 엔티티의 이름을 재입력할 경우  엔티티 업데이트가 가능하다. (.jhipster 디렉토리에 .json파일 참조)

- 재생성 / 필드, 관계 추가 / 필드, 관계 제거 등의 옵션 선택이 가능한다.

참조 : https://www.jhipster.tech/creating-an-entity/

command line에서 jhipster generator를 통한 어플리케이션 생성 시 옵션을 줄 수 있다.

(옵션 보기 : jhipster app --help)

• --help : 옵션 보기
• --blueprint : - 사용할 블루 프린트 설정 ex> jhipster --blueprint kotlin
• --skip-cache : Do not remember prompt answers (Default: false)
• --skip-git : git에 자동 등록하지 않기.
• --skip-install : 의존성 자동 설치 하지 않기.
• --skip-client : server-side 어플리케이션만 생성.
• --skip-server : client-side 어플리케이션만 생성.
• --skip-user-management : 사용자 관리 생략. 
• --i18n : client-side 생략시 다국어 생략.
• --auth : server-side 생략시 인증 타입 선택.
• --db : server-side 생략시 DB타입 선택
• --with-entities : .jhipster폴더에 있는 엔티티 설정 정보로 엔티티 재생성.
• --skip-checks : 필요 도구 확인 생략.
• --jhi-prefix : services, components, state/route이름 접두어 설정. (기본 : jhi)
• --entity-suffix : 엔티티 class이름 접미어 설정. (기본 : x)
• --dto-suffix : DTO의 접미어 설정. (기본 : DTO)
• --yarn : NPM 대신 Yarn을 기본 설정으로 사용.
• --prettier-java : Java 클래스 포멧에 prettier-java을 사용.
• --experimental
• --skip-fake-data : liquibase fake data 생성 생략.
• --creation-timestamp

--force를 추가시 기존에 존재하는 파일들을 덮어쓰기한다.

엔티티를 포함해서 모든 어플리케이션 재성성시 : jhipster --force --with-entities

참조 : https://www.jhipster.tech/creating-an-app/

일전의 환경 설정과 로컬 jhipster-generator가 설치되어있다는 가정

(npm -g generator-jhipster *이전의 jhipster설치 글 참조)

터미널에서 폴더를 생성한 후 해당 폴더로 이동.

• jhipster 입력 후 커맨드에 나오는 질의에 원하는 어플리케이션의 형태에 따라 옵션을 선택
• 어플리케이션 생성 완료 후 해당 폴더에서 ./mvnw 또는 ./gradlew 입력시 개발(-Pdev) 환경 어플리케이션을 실행하게 된다.(http://localhost:8080 에서 이용)
• JavaScript/TypeScript live reload를 원할 시 npm start 또는 yarn start를 실행한다.
  (live reload 이용시 ./mvnw -P-webpack or ./gradlew -x webpack를 이용. webpack 관련 설정을 제외, 서버 실행 속도를 높일 수 있다.)

어플리케이션 옵션

1. Which type of application would you like to create?

Monolithic이 가장 대중적인 형태

• Monolithic application
• Microservice application
• Microservice gateway
• JHipster UAA serve

2. What is the base name of your application?

• 만들 어플리케이션 이름 입력

3. What is your default Java package name?

• 자바 패키지 계층 설정

4. Do you want to use the JHipster Registry to configure, monitor and scale your application?

• 마이크로서비스 형태 선택시 필수 선택

5. Which typeof authentication would you like to use?

원하는 인증 타입을 선택

• JWT authentication
• OAuth 2.0 / OIDC Authentication
• HTTP Session Authentication
• Authentication with JHipster UAA server

6. Which type of database would you like to use?

원하는 데이터베이스 형태 (RDBMS?NO-SQL? 를 결정)

• An SQL database (H2, MySQL, MariaDB, PostgreSQL, MSSQL, Oracle), which you will access with Spring Data JPA
• MongoDB
• Cassandra
• Couchbase
• Neo4j
• No database (only available when using a microservice application with JWT authentication)

7. Which production database would you like to use?

• 배포환경에서 사용할 db(src/main/resources/config/application-prod.yml에서 확인)

8. Which development database would you like to use?

개발환경에서의 db (src/main/resources/config/application-dev.yml에서 확인)

• H2, running in-memory.
  • 서버 재시작시 data 초기화됨
• H2, with its data stored on disk.
  • 파일 형태로 로컬 pc에 저장(*권장)
• The same database as the one you chose for production
  • 배포환경과 동일한 환경으로 db를 이용하나 설정이 복잡 (도커 사용)

9. Do you want to use the Spring cache abstraction?

스프링 캐쉬를 사용할 지, 성능상의 이슈에 따라 결정

• ehcache(local cache)
• Caffeine (local cache)
• Hazelcast (distributed cache)
• Infinispan (distributed cache)
• Memcached (another distributed cache)
• Redis (configured as a single server cache).

10. Do you want to use Hibernate 2nd level cache?

• SQL DB 선택시만 사용 가능(Jhipster가 JPA를 사용하기 때문)

11. Would you like to use Maven or Gradle?

빌드 툴 택 1

• maven
• gradle

12. Which other technologies would you like to use?

• API first development using swagger-codegen
• Search engine using ElasticSearch
• Clustered HTTP sessions using Hazelcast
• WebSockets using Spring Websocket
• Asynchronous messages using Apache Kafka

13. Which Framework would you like to use for the client?

• Angular
• React
• VueJs (* jhipster에서 제공하는 뷰 템플릿 관련 공식 라이브러리 추가 설치 필요)

    ([https://github.com/jhipster/jhipster-vuejs](https://github.com/jhipster/jhipster-vuejs))

14. Would you like to use a Bootswatch theme?

부트스트랩 테마 결정

15. Would you like to use the Sass stylesheet preprocessor for your CSS?

프론트엔드 빌드시 Sass 전처리기를 사용할지 여부

16. Would you like to enable internationalization support?

다국어 사용 여부

17. Which testing frameworks would you like to use?

기본으로 Spring-Junit, JavaScript-Jest을 제공함.

• Performance tests using Gatling
• Behaviour tests using Cucumber
• Angular integration tests with Protractor

18. Would you like to install other generators from the JHipster Marketplace?

출처 : https://www.jhipster.tech/creating-an-app/

jhipster는 docker를 통해 개발과 배포에 있어서 편리함을 제공한다.

docker를 이용하면?

• 배포 환경과 동일한 환경에서 개발이 가능하다.
• 인프라 확장이 용이하다. (docker-compose scale)

1. 환경

jhipster가 제공하는 도커 환경을 이용하기 위해 도커와 도커 컴포즈 설치가 선행되어야 한다.

• docker(https://docs.docker.com/get-docker/)
• docker compose(https://docs.docker.com/compose/install/)

2. 도커 이미지 만들기

java애플리케이션을 도커 이미지로 만들기 위해 Jib(https://github.com/GoogleContainerTools/jib) 라이브러리를 이용한다.

2.1 로컬에 설치된 도커데몬을 이용

• With Maven, type: ./mvnw package -Pprod verify jib:dockerBuild
• With Gradle, type: ./gradlew -Pprod bootJar jibDockerBuild

2.2 로컬에 도커 설치 없이 빌드 후 도커 레지스트리 배포

• With Maven, type: ./mvnw package -Pprod verify jib:build
• With Gradle, type:./gradlew -Pprod bootJar jib

2.3 오프라인 환경에서 이용

• jib은 docker registry에서 최신 버전의 이미지를 받아오는게 우선적이므로, 인터넷이 불가능한 환경이라면 아래와 같이 이용.
  (cache에 저장된 이미지를 사용 )

• With Maven, type : ./mvnw -Pprod package verify jib:dockerBuild --offlineWith

• Gradle, type : ./gradlew -Pprod bootJar jibDockerBuild --offline

2.4 기타

docker-compose -f src/main/docker/app.yml up 시 기타 필요한 환경 컨테이너를 함께 띄운다.

만약, 각각의 따로 띄우거나 컨트롤 하고 싶다면 src/main/docker의 *.yml 파일을 참조하여 이용하면 된다.

• PostgreSQL : docker-compose -f src/main/docker/postgresql.yml up,
• Elasticsearch : docker-compose -f src/main/docker/elasticsearch.yml up
• Sonar : docker-compose -f src/main/docker/sonar.yml up

3. 도커이미지 띄우기

2.번에서 빌드한 도커 이미지를 가동시키기 위한 cmd

• docker-compose -f src/main/docker/app.yml up
  (db, search engine, registry 등 연관 이미지를 함께 가동시킴)
• 도커 *.yml 위치 : src/main/docker

4. 도커 커맨드

• 모든 컨테이너 확인
  - docker container ps -a
• 컨테이너 상태 확인(cpu, menory등의 관련 정보)
  - docker container stats
• 컨테이너 스케일 조정
  - docker-compose scale test-app=4("test"어플리케이션의 인스턴스를 4개로 조정)
• 컨테이너 멈추기
  - docker-compose -f src/main/docker/app.yml stop
  - docker container stop <container_id>
• 컨테이너 삭제**
  - docker container rm <container_id>**

출처 : https://www.jhipster.tech/docker-compose/

1. 설방법은 세가지로 나눔.

1-1. jhipster에서 제공하는 온라인 툴.

https://start.jhipster.tech/#/

1-2. npm 또는 yarn을 이용.

1-3. jhipster가 설치된 도커 컨테이너를 이용.

공식 홈페이지에서 두번째 npm, yarn을 이용을 권장하고 있으므로 이 방법을 사용함. (npm을 권장)

(1의 방법은 jhipster의 모든 기능을 이용할 수 없다는 단점이 있음. 3의 방법은 1,2의 방법과 비교했을 때 러닝커브가 존재)

2. NPM을 통한 설치

• java11, node.js (LTS 64bit)가 미리 설치되어야함.

• npm install -g generator-jhipster 로 jhipster 생성기를 설치

  (추가적으로 jhipster마켓에서 추가적인 모듈을 이용하고 싶다면 ? Yeoman 설치 : npm install -g yo)

• yarn으로 설치시 :

  • yarn global add yo
  • yarn global add generator-jhipster

출처 : https://www.jhipster.tech/installation/