Gradle + SpringBoot+ GraphQL

카테고리	기술
태그	SpringBoot Gradle VSCode MariaDB Java GraphQL
수정일	Aug 3, 2024
작성일	Mar 19, 2024

💡

전체 소스 코드는 여기를 참고 해주세요.

프로젝트 환경

VSCode 1.86.0
Gradle 8.6
SpringBoot 3.2.3
java 17
mariaDB (feat. dbeaver)

설치

Database

DBeaver 설치
“achro” 이름의 Database 생성 (본 예제는 MariaDB 기본 설정 이용)

JDK 17 설치

https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html

VSCode Extensions

Extension Pack for Java vscjava.vscode-java-pack
Gradle for Java vscjava.vscode-gradle
Spring Boot Tools vmware.vscode-spring-boot
Spring Initializr Java Support vscjava.vscode-spring-initializr

VSCode settings

// ~/.vscode/settings.json

{
    "java.compile.nullAnalysis.mode": "automatic",
    "java.configuration.updateBuildConfiguration": "automatic"
}

프로젝트 생성

Ctrl + Shift + P or Command + Shift + P
Java: Create Java Project… 선택
Select the project type ⇒ Spring Boot
Select prject type. ⇒ Gradle project
Specify Spring Boot version ⇒ 3.2.3
Specify project language. ⇒ Java
Input Group Id for your project. ⇒ com.croot
Input Artifact Id for your project. ⇒ achro
Specify packaging type. ⇒ Jar
Specify Java version ⇒ 17
Search dependencies. ⇒ none

Gradle 설정

~/build.gradle

// build.gradle

plugins {
	id 'java'
	id 'org.springframework.boot' version '3.2.3'
	id 'io.spring.dependency-management' version '1.1.4'
}

java {
	group = 'com.achro'
	version = '0.0.1-SNAPSHOT'
	sourceCompatibility = '17'
}

repositories {
    mavenCentral()
}

dependencies {
	// Spring Boot
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'org.springframework.boot:spring-boot-starter-web'
	implementation 'com.graphql-java-kickstart:graphql-spring-boot-starter:15.0.0'
    testImplementation 'com.graphql-java-kickstart:graphql-spring-boot-starter-test:15.0.0'
	compileOnly 'org.projectlombok:lombok'
	annotationProcessor 'org.projectlombok:lombok'

	// DB
	runtimeOnly 'org.mariadb.jdbc:mariadb-java-client:3.3.3'
}

Gradle 의존성 관리 속성

- `complieClasspath` : 프로젝트 소스 코드 컴파일 시 필요한 모든 클래스, 라이브러리
- `runtimeClasspath` : 프로젝트 실행 시 필요한 모든 클래스, 라이브러리
- `runtimeOnly` : 런타임 시점에만 필요할 경우
- `compileOnly` : 컴파일 시점에만 필요할 경우
- `implementation` : 컴파일 및 런타임 모두 필요

프로젝트 설정

~/src/main/resources/application.properties

# application.properties

server.port=8000
spring.application.name=achro

graphql.servlet.enabled=true
graphql.altair.enabled=true
graphql.playground.enabled=true


# DB Properties
spring.jpa.hibernate.ddl-auto=create
spring.datasource.driverClassName=org.mariadb.jdbc.Driver
spring.datasource.url=jdbc:mariadb://localhost:3306/achro
spring.datasource.username=root
spring.datasource.password=

~/src/main/resources/graphql/schema.graphqls

// schema.graphqls

schema{
    query: Query
}

type Member{
    id: ID!
    name: String!
    age: Int!
}

type Query{
    getMember(id: ID!): Member
    getAllMembers: [Member]
}

디렉토리 구조 및 소스코드

~/src/main/java/com/croot/achro
|- model/
|- repository/
|- service/
`- ApiApplication.java

model/

`Member.java`

```java // ~/src/main/java/com/croot/achro/model/Member.java package com.croot.achro.model; import lombok.Getter; import lombok.Setter; import jakarta.persistence.*; @Entity @Table(name="MEMBER") @Getter @Setter public class Member { @Id @GeneratedValue(strategy = GenerationType.AUTO) @Column(name = "MEMBER_ID") private Integer id; @Column(name = "MEMBER_NAME") private String name; @Column(name = "MEMBER_AGE") private Integer age; } ```

repository/

`MemberRepository.java`

```java // ~/src/main/java/com/croot/achro/repository/MemberRepository.java package com.croot.achro.repository; import com.croot.achro.model.Member; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.stereotype.Repository; @Repository public interface MemberRepository extends JpaRepository<Member, Integer> { } ```

service/

`MemberService.java`

```java // ~/src/main/java/com/croot/achro/service/MemberService.java package com.croot.achro.service; import graphql.kickstart.tools.GraphQLQueryResolver; import java.util.List; import org.springframework.stereotype.Service; import com.croot.achro.model.Member; import com.croot.achro.repository.MemberRepository; @Service public class MemberService implements GraphQLQueryResolver { private final MemberRepository memberRepository; public MemberService(MemberRepository memberRepository) { this.memberRepository = memberRepository; } public List getAllMembers(){ return memberRepository.findAll(); } public Member getMember(Integer id){ return memberRepository.findById(id).get(); } } ``` </details>

`LoadDataService.java` : 초기 데이터를 넣기 위한 서비스

```java // ~/src/main/java/com/croot/achro/service/LoadDataService.java package com.croot.achro.service; import com.croot.achro.model.Member; import com.croot.achro.repository.MemberRepository; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import jakarta.annotation.PostConstruct; @Service public class DataLoaderService { @Autowired private MemberRepository memberRepository; @PostConstruct public void load() { // 데이터 추가 for (int i = 1; i <= 10; i++) { Member member = new Member(); member.setName("Member " + i); // Member 이름 설정 member.setAge(i * 10); // Member 나이 설정 memberRepository.save(member); } } } ```

## 실행 1. [http://localhost:8000/playground](http://localhost:8000/playground) 접속 2. 쿼리 작성 ```graphql query { getAllMembers{ id name age } } ``` 3. 결과 확인 ![0](/assets/img/2024-03-19-Gradle-+-SpringBoot+-GraphQL.md/0.png)_Untitled.png_ ## REFS. GraphQL Java Kickstart Getting started - [https://www.graphql-java-kickstart.com/spring-boot/getting-started/](https://www.graphql-java-kickstart.com/spring-boot/getting-started/) ## ERROR.LOG **Prob.** VSCode에서 `build.gradle` 수정 **Solv.** 1. 해당 파일 우클릭 2. “Reload Projects” 를 선택 해주어야한다. **Prob.** Run Java 시 아래와 같은 에러 발생. ```javascript Type definition for root mutation type 'Mutation' not found! ``` **Solv.** `~/src/main/resources/graphql/schema.graphqls` 에 “Mutation”을 정의했으나 리졸버(Resolver)가 없어서 발생. 1. schema.graphqls 수정 or Resolver 작성

Previous Feb 29, 2024
« 제로 트러스트 가이드라인

Mar 19, 2024 Next
Proxy와 Reflect »