diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d70d5a9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +*# +*.iml +*.ipr +*.iws +*.jar +*.sw? +*~ +.#* +.*.md.html +.DS_Store +.attach_pid* +.classpath +.factorypath +.gradle +.metadata +.project +.recommenders +.settings +.springBeans +.vscode +/code +MANIFEST.MF +_site/ +activemq-data +bin +build +!/**/src/**/bin +!/**/src/**/build +build.log +dependency-reduced-pom.xml +dump.rdb +interpolated*.xml +lib/ +manifest.yml +out +overridedb.* +target +.flattened-pom.xml +secrets.yml +.gradletasknamecache +.sts4-cache + +.idea \ No newline at end of file diff --git a/HELP.md b/HELP.md new file mode 100644 index 0000000..af429c6 --- /dev/null +++ b/HELP.md @@ -0,0 +1,22 @@ +# Getting Started + +### Reference Documentation +For further reference, please consider the following sections: + +* [Official Gradle documentation](https://docs.gradle.org) +* [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/3.4.3/gradle-plugin) +* [Create an OCI image](https://docs.spring.io/spring-boot/3.4.3/gradle-plugin/packaging-oci-image.html) +* [Spring Web](https://docs.spring.io/spring-boot/3.4.3/reference/web/servlet.html) + +### Guides +The following guides illustrate how to use some features concretely: + +* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/) +* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/) +* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/) + +### Additional Links +These additional references should also help you: + +* [Gradle Build Scans – insights for your project's build](https://scans.gradle.com#gradle) + diff --git a/README.md b/README.md index ebeffaf..bc0452b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,290 @@ -# spring-tutorial-21st -CEOS back-end 21st spring tutorial project +# CEOS Backend Study Week 1 + +## 1. Spring Tutorial + +### Initial Setting + +- Project : Gradle - Groovy +- Language : Java 17 +- Spring Boot : 3.2.9 +- Project Metadata + - Group : com.ceos21 + - Artifact : springboot + - Packaging : Jar + - Java version : 17 +- Dependencies + - Spring Web + +### H2 Database + +- reference: [reference doc](https://phantom.tistory.com/59) + +- 실행: `h2/bin/h2.sh` → `./h2.sh` +- 접속: `8082`앞부분을 `localhost`로 바꾸기 +- 최초 서버 실행 + - JDBC URL : `jdbc:h2:~/ceos21` + - User Name: `sa` +- 이후 서버 실행 + - JDBC URL : `jdbc:h2:tcp://localhost/~/ceos21` → TCP 접속 + - User Name: `sa` +- Dependencies + + ```jsx + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + runtimeOnly 'com.h2database:h2' + ``` + +- Application.yml + + ```jsx + spring: + datasource: + url: jdbc:h2:tcp://localhost/~/ceos21 + username: sa + password: + driver-class-name: org.h2.Driver + + jpa: + hibernate: + ddl-auto: create + properties: + hibernate: + format_sql: true + + logging: + level: + org.hibernate.SQL: debug + ``` + + +### 테스트 관련 + +- Dependencies + + ```jsx + testImplementation('org.springframework.boot:spring-boot-starter-test') + ``` + +- `MockMvc` + - reference: [reference doc](https://terasolunaorg.github.io/guideline/5.4.1.RELEASE/en/UnitTest/ImplementsOfUnitTest/UsageOfLibraryForTest.html#mockmvc) + + 1. test method에서 HTTP 기반 요청 보냄 + 2. **MockMvc가 TestDispatcherServlet에 가상의 요청 전송 → mock request** + - Dispatcher servlet은 request를 받아서 맞는 controller를 찾는 역할 + 3. TestDispatcherServelet이 Controller에 매칭되는 메소드를 불러서 요청 처리 + 4. test method는 mockMvc로부터 결과를 받고 verify를 함 + ![MockMvc](./readme-src/mockmvc.png) + + - `@SpringBootTest` + `@AutoConfigureMockMvc` → `webAppContextSettup`기반 + - MockMvc 옵션 + 1. `webAppContextSetup`: **Spring의 전체 애플리케이션 컨텍스트(ApplicationContext)를 로드**하여 테스트하는 방식 + 2. `standaloneSetup`: **테스트 대상이 되는 Controller만 로드**하여 실행 (mock객체를 직접 주입해야함) + ```java + import org.junit.jupiter.api.DisplayName; + import org.junit.jupiter.api.Test; + import org.springframework.beans.factory.annotation.Autowired; + import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; + import org.springframework.boot.test.context.SpringBootTest; + import org.springframework.http.MediaType; + import org.springframework.test.web.servlet.MockMvc; + import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; + import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; + import static org.hamcrest.core.IsEqual.equalTo; + + @SpringBootTest + @AutoConfigureMockMvc + public class HelloControllerTest { + @Autowired + private MockMvc mvc; + + @DisplayName("DisplayName: 테스트 이름 설정") + @Test + public void getHello() throws Exception { + mvc.perform(MockMvcRequestBuilders.get("/").accept(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andExpect(content().string(equalTo("Greetings from Spring Boot!"))); + } + } + + ``` + + +## 2. Spring이 지원하는 기술(IoC/DI, AOP, PSA) 조사 + +### Spring IoC Container + +- **객체의 생성과 관리를 개발자가 아닌 Spring 프레임워크가 담당**하는 개념 (Inversion of Control) +- IoC 컨테이너 작동 방식 + 1. 객체를 class로 정의 + 2. 객체들 간 연관성 지정: Spring Config file / Annotation(`@Component` , `@Configuration`, `@Autowired`, `@Bean`)을 통해 객체들이 어떻게 연결될지(의존성 주입) 지정 + 3. IoC 컨테이너가 이 정보를 바탕으로 객체들을 생성하고 필요한 곳에 주입 + +### Spring DI(Dependency Injection) + +- 객체가 생성자 인수, 팩토리 메서드에서 생성되거나 반환된 후에, 객체 인스턴스에 설정된 속성을 통해서만 종속성을 정의하는 프로세스 → **의존성을 외부에서 주입받음** +- 의존성 주입 방식 + 1. 생성자 주입 (Constructor Injection) 🤩 → 객체 불변성(immutability) 보장 + - `@RequiredArgsConstructor` 등을 하면 Lombok이 생성자를 자동으로 생성해줌 + 2. Setter 주입 (Setter Injection) → 런타임에 의존성 주입 + 3. 필드 주입 (Field Injection) → 런타임에 의존성 주입 + +### AOP(Aspect Oriented Programming) + +- **반복 사용되는 로직들을 모듈화 하여 필요할때 호출해서 사용하는 방법** + + ![AOP](./readme-src/aop.png) + +- Proxy 기반 AOP + - `CGLib`을 이용해서 Proxy 객체를 만들어냄 + - 프록시 객체가 메서드 실행 전후에 부가 기능(횡단 관심사)을 추가 → 이후 실제 객체를 호출 + + +### PSA(Portable Service Abstraction) + +- 환경의 변화와 관계없이 일관된 방식의 기술로의 접근 환경을 제공하는 추상화 구조 + +![PSA](./readme-src/psa.png) + +- `DBClient`에서 어떤 `Connector` 객체에 접근하려해도 모두 같은 추상화된 interface를 거치고 `getConnection()`으로 접근 가능함 + +## 3. Spring Bean이란? Bean의 life cyle? + +### Spring Bean + +- **Spring 컨테이너가 관리하는 자바의 객체** +- Spring은 빈(Bean)을 통해 객체를 인스턴스화한 후, 객체 간의 의존 관계를 관리 +- 클래스에 `@Component` 어노테이션 추가 → Spring이 자동으로 해당 클래스를 스캔 & Bean으로 등록 +- `@Component` → `@Autowired` : **묵시적 빈 정의** + - 클래스에 어노테이션을 추가 → Autowired로 다른 클래스에서 해당 Bean을 끌어옴 +- `@Configuration` → `@Bean` : **명시적 빈 정의** + - Spring 설정 파일에 Configuration 어노테이션을 추가 → Bean 어노테이션을 붙여 명시적으로 빈을 지정 + +### Bean Life Cycle + +- Spring이 객체(Bean)의 생성과 소멸 및 생명주기를 관리 +1. 스프링 IoC 컨테이너 생성 → `ApplicationContext` 로드 +2. 스프링 빈 생성 → `@Component`, `@Bean` +3. 의존관계 주입 → `@Autowired` +4. 초기화 콜백 메소드 호출 → `@PostConstruct` (빈 생성 후 바로 실행됨) +5. 사용 +6. 소멸 전 콜백 메소드 호출 → `@PreDestroy` (컨테이너 종료 직전 실행됨) +7. 스프링 종료 + +## 4. Spring Annotation 분석 + +### 어노테이션의 활용 + +- Spring에서는 어노테이션을 활용하여 **의존성 주입(DI), AOP, 설정 관리** 등을 수행 + +### 어노테이션을 통한 Bean 등록 + +- Spring에서 **어노테이션을 통해 빈을 자동 등록(Bean Registration)** 할 수 있음 +1. Spring이 `@ComponentScan`을 실행하여 특정 패키지를 스캔 +2. 해당 패키지 내에서 `@Component`, `@Service`, `@Repository`, `@Controller`가 붙은 클래스를 찾음 +3. 찾은 클래스를 Spring 컨테이너(ApplicationContext)에 등록 → Bean으로 관리 +4. 의존성 주입(DI)을 통해 필요한 곳에 Bean을 자동 연결 (`@Autowired` 어노테이션 사용) + +## 5. 단위 테스트 vs 통합 테스트 + +### 단위 테스트(Unit Test) + +- 개별 모듈 또는 클래스의 기능을 검증하는 것에 초점을 맞춘 테스트 +- 도구: JUnit 5, Mockito, AssertJ, Spring Boot Test + +### 통합 테스트(Integration Test) + +- 모듈이 서로 통합되어 상호작용할 때 방생할 수 있는 문제를 찾아내고 해결하는 데 중점을 둔 테스트 +- 도구: Spring Boot Test, TestContainers + +--- +### Component Scan의 플로우 +1. `@SpringBootApplication` → `ComponentScan` 어노테이션 + - `@Component`, `@Service`, `@Repository`, `@Controller`가 붙은 객체 등록 + - ![springboot](./readme-src/springboot.png) +2. `@Service` & `@Controller` + - `@Service` → `@Component` + - `@RestController` → `@Controller` → `@Component` + - ![Service & Controller](./readme-src/servicencontroller.png) +3. `@Repository`로 등록하지 않았지만 Repository가 Jpa Repository를 상속받는다면 Component로 등록됨 + - SpringBoot에서 `@EnableJpaRepositories`가 설정되어 있음 → `@Import(JpaRepositoriesRegistrar.class)`에서 JpaRepositoriesRegistrar가 JpaRepository를 상속받는 모든 interface를 빈으로 등록 + - ![repository](./readme-src/repository.png) + +### Custom Annotation과 AOP를 적용한 로깅 +- 사용자 정의 Annotation + + ```jsx + @Retention(RetentionPolicy.RUNTIME) + @Target(ElementType.TYPE) + public @interface SampleAnnotation {} + ``` + + 1. `@interface` 선언 + 2. `@Retention` (어노테이션을 어느 기간이 유지할건지), `@Target` (어떤 것에 적용할건지) 설정 + - 옵션 reference: [options](https://velog.io/@juhyeon1114/%EC%BB%A4%EC%8A%A4%ED%85%80-Annotation-%EB%A7%8C%EB%93%A4%EA%B8%B0) + 3. `@Aspect` 어노테이션이 붙은 AOP 클래스 생성해서 어노테이션 동작 로직 작성 + 4. 커스텀 어노테이션을 적용하고 싶은 곳에 어노테이션을 붙이고 사용 + +- AOP Dependencies + + ```jsx + implementation 'org.springframework.boot:spring-boot-starter-aop' + ``` + +- reference: [reference doc](https://velog.io/@jjeongdong/Spring-AOP%EB%A5%BC-%ED%99%9C%EC%9A%A9%ED%95%9C-Logging-%EA%B5%AC%ED%98%84) +- 구현 - `@LogRecord` 인터페이스 정의 + + ```jsx + @Target(ElementType.METHOD) + @Retention(RetentionPolicy.RUNTIME) + public @interface LogRecord { + } + ``` + +- 구현 - 어노테이션 동작 로직 정의 + + ```jsx + @Aspect + @Component + @Slf4j + public class LogAspect { + + @Around("@annotation(com.ceos21.springboot.annotation.logRecord.LogRecord)") + public Object logRecord(ProceedingJoinPoint joinPoint) throws Throwable { + MethodSignature signature = (MethodSignature) joinPoint.getSignature(); + Method method = signature.getMethod(); + log.info("[START] ======= method name = {} =======", method.getName()); + + long startTime = System.currentTimeMillis(); + Object result = joinPoint.proceed(); + long executionTime = System.currentTimeMillis() - startTime; + + log.info("[END] ======= method executionTime = {} =======", executionTime); + + return result; + } + } + + ``` + +- 구현 - 원하는 곳에 어노테이션 적용 + + ```jsx + @Service + @RequiredArgsConstructor + @Slf4j + public class TestService { + private final TestRepository testRepository; + + /* Read All */ + @Transactional(readOnly = true) + @LogRecord + public List findAllTests() { + return testRepository.findAll(); + } + } + ``` +- 실행 결과 + - ![result](./readme-src/logging.png) \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..439563b --- /dev/null +++ b/build.gradle @@ -0,0 +1,36 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.4.3' + id 'io.spring.dependency-management' version '1.1.7' +} + +group = 'com.ceos21' +version = '0.0.1-SNAPSHOT' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + testImplementation('org.springframework.boot:spring-boot-starter-test') + + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + runtimeOnly 'com.h2database:h2' + + implementation 'org.springframework.boot:spring-boot-starter-aop' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..37f853b --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..faf9300 --- /dev/null +++ b/gradlew @@ -0,0 +1,251 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9d21a21 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/readme-src/aop.png b/readme-src/aop.png new file mode 100644 index 0000000..48c28ef Binary files /dev/null and b/readme-src/aop.png differ diff --git a/readme-src/logging.png b/readme-src/logging.png new file mode 100644 index 0000000..700114c Binary files /dev/null and b/readme-src/logging.png differ diff --git a/readme-src/mockmvc.png b/readme-src/mockmvc.png new file mode 100644 index 0000000..f98191e Binary files /dev/null and b/readme-src/mockmvc.png differ diff --git a/readme-src/psa.png b/readme-src/psa.png new file mode 100644 index 0000000..a56938b Binary files /dev/null and b/readme-src/psa.png differ diff --git a/readme-src/repository.png b/readme-src/repository.png new file mode 100644 index 0000000..aa1d634 Binary files /dev/null and b/readme-src/repository.png differ diff --git a/readme-src/servicencontroller.png b/readme-src/servicencontroller.png new file mode 100644 index 0000000..9b80936 Binary files /dev/null and b/readme-src/servicencontroller.png differ diff --git a/readme-src/springboot.png b/readme-src/springboot.png new file mode 100644 index 0000000..12f74a2 Binary files /dev/null and b/readme-src/springboot.png differ diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..9c02403 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'springboot' diff --git a/src/main/java/com/ceos21/springboot/SpringbootApplication.java b/src/main/java/com/ceos21/springboot/SpringbootApplication.java new file mode 100644 index 0000000..5d75388 --- /dev/null +++ b/src/main/java/com/ceos21/springboot/SpringbootApplication.java @@ -0,0 +1,37 @@ +package com.ceos21.springboot; + +import com.ceos21.springboot.annotation.logRecord.LogRecord; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.boot.CommandLineRunner; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.stereotype.Component; +import org.springframework.web.bind.annotation.RequestParam; + +import java.util.Arrays; + +@SpringBootApplication +public class SpringbootApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringbootApplication.class, args); + } + +// @Bean +// public CommandLineRunner CommandLineRunner(ApplicationContext ctx) { +// return args -> { +// System.out.println("Let's inspect the beans provided by Spring Boot:"); +// +//// SpringBoot에서 제공되는 Bean 확인 +// String[] beanNames = ctx.getBeanDefinitionNames(); +// Arrays.sort(beanNames); +// for (String beanName : beanNames) { +// System.out.println(beanName); +// } +// }; +// } + +} diff --git a/src/main/java/com/ceos21/springboot/annotation/logRecord/LogAspect.java b/src/main/java/com/ceos21/springboot/annotation/logRecord/LogAspect.java new file mode 100644 index 0000000..020ca38 --- /dev/null +++ b/src/main/java/com/ceos21/springboot/annotation/logRecord/LogAspect.java @@ -0,0 +1,31 @@ +package com.ceos21.springboot.annotation.logRecord; + +import lombok.extern.slf4j.Slf4j; +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; +import org.aspectj.lang.reflect.MethodSignature; +import org.springframework.stereotype.Component; + +import java.lang.reflect.Method; + +@Aspect +@Component +@Slf4j +public class LogAspect { + + @Around("@annotation(com.ceos21.springboot.annotation.logRecord.LogRecord)") + public Object logRecord(ProceedingJoinPoint joinPoint) throws Throwable { + MethodSignature signature = (MethodSignature) joinPoint.getSignature(); + Method method = signature.getMethod(); + log.info("[START] ======= method name = {} =======", method.getName()); + + long startTime = System.currentTimeMillis(); + Object result = joinPoint.proceed(); + long executionTime = System.currentTimeMillis() - startTime; + + log.info("[END] ======= method executionTime = {} =======", executionTime); + + return result; + } +} diff --git a/src/main/java/com/ceos21/springboot/annotation/logRecord/LogRecord.java b/src/main/java/com/ceos21/springboot/annotation/logRecord/LogRecord.java new file mode 100644 index 0000000..cdc982c --- /dev/null +++ b/src/main/java/com/ceos21/springboot/annotation/logRecord/LogRecord.java @@ -0,0 +1,11 @@ +package com.ceos21.springboot.annotation.logRecord; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +public @interface LogRecord { +} diff --git a/src/main/java/com/ceos21/springboot/controller/HelloController.java b/src/main/java/com/ceos21/springboot/controller/HelloController.java new file mode 100644 index 0000000..220378c --- /dev/null +++ b/src/main/java/com/ceos21/springboot/controller/HelloController.java @@ -0,0 +1,12 @@ +package com.ceos21.springboot.controller; + +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class HelloController { + @GetMapping("/") + public String index() { + return "Greetings from Spring Boot!"; + } +} diff --git a/src/main/java/com/ceos21/springboot/controller/TestController.java b/src/main/java/com/ceos21/springboot/controller/TestController.java new file mode 100644 index 0000000..24201e0 --- /dev/null +++ b/src/main/java/com/ceos21/springboot/controller/TestController.java @@ -0,0 +1,23 @@ +package com.ceos21.springboot.controller; + +import com.ceos21.springboot.entity.Test; +import com.ceos21.springboot.service.TestService; +import lombok.RequiredArgsConstructor; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +import java.util.List; + +@RestController +@RequiredArgsConstructor +@RequestMapping("/tests") +public class TestController { + private final TestService testService; + + @GetMapping + public List findAllTests() { + return testService.findAllTests(); + } +} diff --git a/src/main/java/com/ceos21/springboot/entity/Test.java b/src/main/java/com/ceos21/springboot/entity/Test.java new file mode 100644 index 0000000..a70417a --- /dev/null +++ b/src/main/java/com/ceos21/springboot/entity/Test.java @@ -0,0 +1,13 @@ +package com.ceos21.springboot.entity; + +import jakarta.persistence.Entity; +import jakarta.persistence.Id; +import lombok.Data; + +@Data +@Entity +public class Test { + @Id + private Long id; + private String name; +} diff --git a/src/main/java/com/ceos21/springboot/repository/TestRepository.java b/src/main/java/com/ceos21/springboot/repository/TestRepository.java new file mode 100644 index 0000000..5117dc3 --- /dev/null +++ b/src/main/java/com/ceos21/springboot/repository/TestRepository.java @@ -0,0 +1,7 @@ +package com.ceos21.springboot.repository; + +import com.ceos21.springboot.entity.Test; +import org.springframework.data.jpa.repository.JpaRepository; + +public interface TestRepository extends JpaRepository { +} diff --git a/src/main/java/com/ceos21/springboot/service/TestService.java b/src/main/java/com/ceos21/springboot/service/TestService.java new file mode 100644 index 0000000..e438d93 --- /dev/null +++ b/src/main/java/com/ceos21/springboot/service/TestService.java @@ -0,0 +1,25 @@ +package com.ceos21.springboot.service; + +import com.ceos21.springboot.annotation.logRecord.LogRecord; +import com.ceos21.springboot.repository.TestRepository; +import com.ceos21.springboot.entity.Test; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.stereotype.Service; +import org.springframework.transaction.annotation.Transactional; + +import java.util.List; + +@Service +@RequiredArgsConstructor +@Slf4j +public class TestService { + private final TestRepository testRepository; + + /* Read All */ + @Transactional(readOnly = true) + @LogRecord + public List findAllTests() { + return testRepository.findAll(); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..e02c51d --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,17 @@ +spring: + datasource: + url: jdbc:h2:tcp://localhost/~/ceos21 + username: sa + password: + driver-class-name: org.h2.Driver + + jpa: + hibernate: + ddl-auto: create + properties: + hibernate: + format_sql: true + +logging: + level: + org.hibernate.SQL: debug \ No newline at end of file diff --git a/src/test/java/com/ceos21/springboot/SpringbootApplicationTests.java b/src/test/java/com/ceos21/springboot/SpringbootApplicationTests.java new file mode 100644 index 0000000..b0bd6c9 --- /dev/null +++ b/src/test/java/com/ceos21/springboot/SpringbootApplicationTests.java @@ -0,0 +1,13 @@ +package com.ceos21.springboot; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class SpringbootApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/com/ceos21/springboot/controllerTest/HelloControllerTest.java b/src/test/java/com/ceos21/springboot/controllerTest/HelloControllerTest.java new file mode 100644 index 0000000..0fe564b --- /dev/null +++ b/src/test/java/com/ceos21/springboot/controllerTest/HelloControllerTest.java @@ -0,0 +1,29 @@ +package com.ceos21.springboot.controllerTest; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.http.MediaType; +import org.springframework.test.web.servlet.MockMvc; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; +import org.springframework.test.web.servlet.request.MockMvcRequestBuilders; + +import static org.hamcrest.core.IsEqual.equalTo; + +@SpringBootTest +@AutoConfigureMockMvc +public class HelloControllerTest { + @Autowired + private MockMvc mvc; + + @DisplayName("DisplayName: 테스트 이름 설정") + @Test + public void getHello() throws Exception { + mvc.perform(MockMvcRequestBuilders.get("/").accept(MediaType.APPLICATION_JSON)) + .andExpect(status().isOk()) + .andExpect(content().string(equalTo("Greetings from Spring Boot!"))); + } +}