zaneanan/template-boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial commit

Browse Source
This commit is contained in:
zaneanan
2026-03-14 23:50:16 +08:00
commit 7dc63dca81
29 changed files with 9708 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
src/main/java/com/boot/bootTemplate/BootTemplateApplication.java Normal file
View File

@@ -0,0 +1,13 @@
package com.boot.bootTemplate;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class BootTemplateApplication {
public static void main(String[] args) {
SpringApplication.run(BootTemplateApplication.class, args);
}
}

7
src/main/java/com/boot/bootTemplate/Role.java Normal file
View File

@@ -0,0 +1,7 @@
package com.boot.bootTemplate;
public enum Role {
USER,
VIP,
ADMIN
}

47
src/main/java/com/boot/bootTemplate/config/ApplicationConfig.java Normal file
View File

@@ -0,0 +1,47 @@
package com.boot.bootTemplate.config;
import com.boot.bootTemplate.repository.UserRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.authentication.AuthenticationProvider;
import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
import org.springframework.security.config.annotation.authentication.configuration.AuthenticationConfiguration;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.core.userdetails.UsernameNotFoundException;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;
@Configuration
@RequiredArgsConstructor
public class ApplicationConfig {
private final UserRepository userRepository; // 確保你有建立 UserRepository
@Bean
public UserDetailsService userDetailsService() {
return username -> userRepository.findByEmail(username)
.orElseThrow(() -> new UsernameNotFoundException("User not found"));
}
@Bean
public AuthenticationProvider authenticationProvider() {
DaoAuthenticationProvider authProvider = new DaoAuthenticationProvider();
authProvider.setUserDetailsService(userDetailsService());
// 正確：這裡必須呼叫 passwordEncoder() 這個 Bean
authProvider.setPasswordEncoder(passwordEncoder());
return authProvider;
}
@Bean
public PasswordEncoder passwordEncoder() {
return new BCryptPasswordEncoder();
}
@Bean
public AuthenticationManager authenticationManager(AuthenticationConfiguration config) throws Exception {
return config.getAuthenticationManager();
}
}

33
src/main/java/com/boot/bootTemplate/config/OpenApiConfig.java Normal file
View File

@@ -0,0 +1,33 @@
package com.boot.bootTemplate.config;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class OpenApiConfig {
@Bean
public OpenAPI customOpenAPI() {
final String securitySchemeName = "bearerAuth";
return new OpenAPI()
.info(new Info()
.title("Boot Template API")
.version("1.0")
.description("這是我的 Spring Boot 範本專案 API 文件"))
// 設定 JWT 認證框
.addSecurityItem(new SecurityRequirement().addList(securitySchemeName))
.components(new Components()
.addSecuritySchemes(securitySchemeName,
new SecurityScheme()
.name(securitySchemeName)
.type(SecurityScheme.Type.HTTP)
.scheme("bearer")
.bearerFormat("JWT")));
}
}

37
src/main/java/com/boot/bootTemplate/controller/AuthenticationController.java Normal file
View File

@@ -0,0 +1,37 @@
package com.boot.bootTemplate.controller;
import com.boot.bootTemplate.dto.auth.AuthenticationRequest;
import com.boot.bootTemplate.dto.auth.AuthenticationResponse;
import com.boot.bootTemplate.dto.auth.RegisterRequest;
import com.boot.bootTemplate.entities.User;
import com.boot.bootTemplate.service.AuthenticationService;
import lombok.RequiredArgsConstructor;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/auth")
@RequiredArgsConstructor
public class AuthenticationController {
private final AuthenticationService service;
@PostMapping("/register")
public AuthenticationResponse register(@RequestBody RegisterRequest request) {
// 沒錯，直接回傳物件就好，攔截器會自動幫你包上 status, message, timestamp
return service.register(request);
}
@PostMapping("/authenticate")
public AuthenticationResponse authenticate(@RequestBody AuthenticationRequest request) {
return service.authenticate(request);
}
@GetMapping("/me")
public String sayHello(@AuthenticationPrincipal User user) {
// 使用 Map 是最快且最安全的方式，Spring 會自動把它轉成 JSON 物件
System.out.println(user.getEmail());
return "你好！你的 Email 是 %s，你的角色是 %s。";
}
}

17
src/main/java/com/boot/bootTemplate/dto/api/ApiResponse.java Normal file
View File

@@ -0,0 +1,17 @@
package com.boot.bootTemplate.dto.api;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class ApiResponse<T> {
private int status; // HTTP 狀態碼 (如 200, 400, 403)
private String message; // 訊息說明
private T data; // 實際資料內容
private long timestamp; // 發生時間
}

15
src/main/java/com/boot/bootTemplate/dto/auth/AuthenticationRequest.java Normal file
View File

@@ -0,0 +1,15 @@
package com.boot.bootTemplate.dto.auth;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class AuthenticationRequest {
private String email;
String password;
}

15
src/main/java/com/boot/bootTemplate/dto/auth/AuthenticationResponse.java Normal file
View File

@@ -0,0 +1,15 @@
package com.boot.bootTemplate.dto.auth;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class AuthenticationResponse {
private String token;
}

17
src/main/java/com/boot/bootTemplate/dto/auth/RegisterRequest.java Normal file
View File

@@ -0,0 +1,17 @@
package com.boot.bootTemplate.dto.auth;
import com.boot.bootTemplate.Role;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data @Builder @AllArgsConstructor @NoArgsConstructor
public class RegisterRequest {
private String email;
private String password;
private Role role; // 或者你在 Service 裡面寫死預設為 USER
}

74
src/main/java/com/boot/bootTemplate/entities/User.java Normal file
View File

@@ -0,0 +1,74 @@
package com.boot.bootTemplate.entities;
import com.boot.bootTemplate.Role;
import jakarta.persistence.*;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.authority.SimpleGrantedAuthority;
import org.springframework.security.core.userdetails.UserDetails;
import java.util.Collection;
import java.util.List;
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@Entity
@Table(name = "_user") // 'user' 在 PostgreSQL 是保留字，建議加底線或改名
public class User implements UserDetails {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Integer id;
@Column(unique = true, nullable = false)
private String email;
private String password;
@Enumerated(EnumType.STRING)
private Role role;
// --- UserDetails 介面實作方法 ---
@Override
public Collection<? extends GrantedAuthority> getAuthorities() {
// 將 Role 轉換為 Spring Security 識別的 Authority
return List.of(new SimpleGrantedAuthority(role.name()));
}
@Override
public String getUsername() {
return email; // 我們使用 email 作為登入帳號
}
@Override
public String getPassword() {
return password;
}
@Override
public boolean isAccountNonExpired() {
return true;
}
@Override
public boolean isAccountNonLocked() {
return true;
}
@Override
public boolean isCredentialsNonExpired() {
return true;
}
@Override
public boolean isEnabled() {
return true;
}
}

68
src/main/java/com/boot/bootTemplate/handler/GlobalExceptionHandler.java Normal file
View File

@@ -0,0 +1,68 @@
package com.boot.bootTemplate.handler;
import com.boot.bootTemplate.dto.api.ApiResponse; // 確保有建立這個類別
import lombok.extern.slf4j.Slf4j;
import org.springframework.dao.DataIntegrityViolationException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.time.Instant;
import java.util.NoSuchElementException;
@RestControllerAdvice
@Slf4j // 為了記錄 log 到檔案中
public class GlobalExceptionHandler {
// 1. 處理 Email 重複（常見於註冊）
@ExceptionHandler(DataIntegrityViolationException.class)
public ResponseEntity<ApiResponse<Object>> handleConflict(DataIntegrityViolationException ex) {
log.warn("資料衝突（可能 Email 重複）: {}", ex.getMessage());
return buildResponse(HttpStatus.CONFLICT, "該帳號已被註冊！");
}
// 2. 處理找不到資料的情況
@ExceptionHandler(NoSuchElementException.class)
public ResponseEntity<ApiResponse<Object>> handleNotFound(NoSuchElementException ex) {
log.warn("資源不存在: {}", ex.getMessage());
return buildResponse(HttpStatus.NOT_FOUND, "找不到該資源");
}
// 3. 捕捉所有未預期的錯誤（兜底）
@ExceptionHandler(Exception.class)
public ResponseEntity<ApiResponse<Object>> handleGeneral(Exception ex) {
// ERROR 級別會觸發你在 logback-spring.xml 設定的錯誤記錄
log.error("伺服器崩潰！原因: ", ex);
return buildResponse(HttpStatus.INTERNAL_SERVER_ERROR, "伺服器發生錯誤，請聯絡管理員");
}
// 4. 處理登入失敗 (密碼錯誤或帳號不存在)
@ExceptionHandler(org.springframework.security.authentication.BadCredentialsException.class)
public ResponseEntity<ApiResponse<Object>> handleBadCredentials(org.springframework.security.authentication.BadCredentialsException ex) {
log.warn("登入失敗: 帳號或密碼錯誤");
return buildResponse(HttpStatus.UNAUTHORIZED, "帳號或密碼錯誤"); // 回傳 401
}
// 處理沒權限或未登入 (403)
@ExceptionHandler(org.springframework.security.access.AccessDeniedException.class)
public ResponseEntity<ApiResponse<Object>> handleAccessDenied(org.springframework.security.access.AccessDeniedException ex) {
log.warn("權限不足，請重新登入");
return ResponseEntity.status(403).body(ApiResponse.builder()
.status(403)
.message("權限不足，請重新登入")
.timestamp(System.currentTimeMillis())
.build());
}
// 輔助方法：統一建構回傳格式
private ResponseEntity<ApiResponse<Object>> buildResponse(HttpStatus status, String message) {
ApiResponse<Object> response = ApiResponse.builder()
.status(status.value())
.message(message)
.data(null)
.timestamp(Instant.now().toEpochMilli())
.build();
return new ResponseEntity<>(response, status);
}
}

61
src/main/java/com/boot/bootTemplate/handler/ResponseHandler.java Normal file
View File

@@ -0,0 +1,61 @@
package com.boot.bootTemplate.handler;
import com.boot.bootTemplate.dto.api.ApiResponse;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.RequiredArgsConstructor;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.StringHttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
import java.time.Instant;
@RestControllerAdvice(basePackages = "com.boot.bootTemplate")
@RequiredArgsConstructor // 自動注入建構子，這會幫你注入 objectMapper
public class ResponseHandler implements ResponseBodyAdvice<Object> {
// 必須注入這個，才能處理 String 轉 JSON 的問題
private final ObjectMapper objectMapper;
@Override
public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
// 如果原本回傳就是 ApiResponse，就不再包裝
return !returnType.getParameterType().equals(ApiResponse.class);
}
@Override
public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
Class<? extends HttpMessageConverter<?>> selectedConverterType,
ServerHttpRequest request, ServerHttpResponse response) {
// 1. 排除 Swagger 與 已經包裝過的 ApiResponse
if (body instanceof ApiResponse || request.getURI().getPath().contains("/v3/api-docs")) {
return body;
}
// 2. 建立統一的包裝物件
ApiResponse<Object> apiResponse = ApiResponse.builder()
.status(200)
.message("success")
.data(body)
.timestamp(Instant.now().toEpochMilli())
.build();
// 3. 處理 String 型態的特殊情況 (一勞永逸法)
if (selectedConverterType.equals(StringHttpMessageConverter.class) || body instanceof String) {
try {
// 強制回傳 JSON 字串，避免 StringHttpMessageConverter 報錯
return objectMapper.writeValueAsString(apiResponse);
} catch (JsonProcessingException e) {
return "{\"status\": 500, \"message\": \"JSON package error\"}";
}
}
return apiResponse;
}
}

10
src/main/java/com/boot/bootTemplate/repository/UserRepository.java Normal file
View File

@@ -0,0 +1,10 @@
package com.boot.bootTemplate.repository;
import com.boot.bootTemplate.entities.User;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.Optional;
public interface UserRepository extends JpaRepository<User, Integer> {
Optional<User> findByEmail(String email);
}

69
src/main/java/com/boot/bootTemplate/security/JwtAuthenticationFilter.java Normal file
View File

@@ -0,0 +1,69 @@
package com.boot.bootTemplate.security;
import jakarta.servlet.FilterChain;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.RequiredArgsConstructor;
import org.springframework.lang.NonNull;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.security.core.userdetails.UserDetailsService;
import org.springframework.security.web.authentication.WebAuthenticationDetailsSource;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.OncePerRequestFilter;
import java.io.IOException;
@Component
@RequiredArgsConstructor
public class JwtAuthenticationFilter extends OncePerRequestFilter {
private final JwtService jwtService;
private final UserDetailsService userDetailsService;
@Override
protected void doFilterInternal(
@NonNull HttpServletRequest request,
@NonNull HttpServletResponse response,
@NonNull FilterChain filterChain
) throws ServletException, IOException {
// 1. 取得 Header 中的 Authorization
final String authHeader = request.getHeader("Authorization");
final String jwt;
final String userEmail;
// 2. 【關鍵點】如果沒有 Token，直接交給下一個過濾器，不做後續驗證
if (authHeader == null || !authHeader.startsWith("Bearer ")) {
filterChain.doFilter(request, response);
return;
}
// 3. 提取 Token (去除 "Bearer " 這 7 個字元)
jwt = authHeader.substring(7);
userEmail = jwtService.extractUsername(jwt);
// 4. 如果有 email 且目前 Security 上下文還沒被驗證過
if (userEmail != null && SecurityContextHolder.getContext().getAuthentication() == null) {
UserDetails userDetails = this.userDetailsService.loadUserByUsername(userEmail);
// 5. 驗證 Token 是否合法
if (jwtService.isTokenValid(jwt, userDetails)) {
UsernamePasswordAuthenticationToken authToken = new UsernamePasswordAuthenticationToken(
userDetails,
null,
userDetails.getAuthorities()
);
authToken.setDetails(new WebAuthenticationDetailsSource().buildDetails(request));
// 6. 更新 Security 上下文，後續請求就代表「已登入」
SecurityContextHolder.getContext().setAuthentication(authToken);
}
}
// 7. 繼續執行過濾鏈
filterChain.doFilter(request, response);
}
}

80
src/main/java/com/boot/bootTemplate/security/JwtService.java Normal file
View File

@@ -0,0 +1,80 @@
package com.boot.bootTemplate.security;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.io.Decoders;
import io.jsonwebtoken.security.Keys;
import org.springframework.security.core.userdetails.UserDetails;
import org.springframework.stereotype.Service;
import javax.crypto.SecretKey;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.function.Function;
@Service
public class JwtService {
// 注意：這是一個 Base64 編碼過的 256-bit 密鑰範例
// 實際開發建議放在 application.yml 並確保長度足夠
private static final String SECRET_KEY = "404E635266556A586E3272357538782F413F4428472B4B6250645367566B5970";
// 1. 從 Token 中提取使用者名稱 (Subject)
public String extractUsername(String token) {
return extractClaim(token, Claims::getSubject);
}
// 2. 泛型方法：提取 Token 內的特定資訊 (Claim)
public <T> T extractClaim(String token, Function<Claims, T> claimsResolver) {
final Claims claims = extractAllClaims(token);
return claimsResolver.apply(claims);
}
// 3. 產生 Token (僅含 UserDetails)
public String generateToken(UserDetails userDetails) {
return generateToken(new HashMap<>(), userDetails);
}
// 4. 產生 Token (含自定義 Claims)
public String generateToken(Map<String, Object> extraClaims, UserDetails userDetails) {
return Jwts.builder()
.claims(extraClaims)
.subject(userDetails.getUsername())
.issuedAt(new Date(System.currentTimeMillis()))
.expiration(new Date(System.currentTimeMillis() + 1000 * 60 * 60 * 24)) // 24小時效期
.signWith(getSignInKey())
.compact();
}
// 5. 驗證 Token 是否合法 (使用者名稱相符且未過期)
public boolean isTokenValid(String token, UserDetails userDetails) {
final String username = extractUsername(token);
return (username.equals(userDetails.getUsername())) && !isTokenExpired(token);
}
// 6. 檢查 Token 是否過期
private boolean isTokenExpired(String token) {
return extractExpiration(token).before(new Date());
}
// 7. 提取過期時間
private Date extractExpiration(String token) {
return extractClaim(token, Claims::getExpiration);
}
// 8. 解析 Token 取得所有 Claims
private Claims extractAllClaims(String token) {
return Jwts.parser()
.verifyWith(getSignInKey())
.build()
.parseSignedClaims(token)
.getPayload();
}
// 9. 獲取簽名用的 Key
private SecretKey getSignInKey() {
byte[] keyBytes = Decoders.BASE64.decode(SECRET_KEY);
return Keys.hmacShaKeyFor(keyBytes);
}
}

60
src/main/java/com/boot/bootTemplate/security/SecurityConfig.java Normal file
View File

@@ -0,0 +1,60 @@
package com.boot.bootTemplate.security;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.authentication.AuthenticationProvider;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
import org.springframework.security.config.http.SessionCreationPolicy;
import org.springframework.security.web.SecurityFilterChain;
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
@Configuration
@EnableWebSecurity
@RequiredArgsConstructor
public class SecurityConfig {
private final JwtAuthenticationFilter jwtAuthFilter;
private final AuthenticationProvider authenticationProvider;
@Bean
public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
http
// 1. 關閉 CSRF (因為我們使用 JWT)
.csrf(AbstractHttpConfigurer::disable)
// 2. 設定權限控管
.authorizeHttpRequests(auth -> auth
// 這裡放完全公開的 API
.requestMatchers("/auth/**").permitAll()
// 這裡放 Swagger / OpenAPI 相關的所有資源路徑
.requestMatchers(
"/v3/api-docs",
"/v3/api-docs/**",
"/swagger-ui/**",
"/swagger-ui.html",
"/swagger-resources/**",
"/webjars/**"
).permitAll()
// 其餘所有請求都需要驗證 (Token)
.anyRequest().authenticated()
)
// 3. 設定 Session 策略為「無狀態」 (Stateless)
.sessionManagement(session ->
session.sessionCreationPolicy(SessionCreationPolicy.STATELESS)
)
// 4. 設定認證提供者
.authenticationProvider(authenticationProvider)
// 5. 在標準過濾器之前加入我們的 JWT 過濾器
.addFilterBefore(jwtAuthFilter, UsernamePasswordAuthenticationFilter.class);
return http.build();
}
}

51
src/main/java/com/boot/bootTemplate/service/AuthenticationService.java Normal file
View File

@@ -0,0 +1,51 @@
package com.boot.bootTemplate.service;
import com.boot.bootTemplate.dto.auth.AuthenticationRequest;
import com.boot.bootTemplate.dto.auth.AuthenticationResponse;
import com.boot.bootTemplate.dto.auth.RegisterRequest;
import com.boot.bootTemplate.security.JwtService;
import com.boot.bootTemplate.entities.User;
import com.boot.bootTemplate.repository.UserRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.security.authentication.AuthenticationManager;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.crypto.password.PasswordEncoder;
import org.springframework.stereotype.Service;
@Service
@RequiredArgsConstructor
public class AuthenticationService {
private final UserRepository repository;
private final PasswordEncoder passwordEncoder;
private final JwtService jwtService;
private final AuthenticationManager authenticationManager;
public AuthenticationResponse register(RegisterRequest request) {
var user = User.builder()
.email(request.getEmail())
.password(passwordEncoder.encode(request.getPassword()))
.role(request.getRole())
.build();
repository.save(user);
var jwtToken = jwtService.generateToken(user);
return AuthenticationResponse.builder()
.token(jwtToken)
.build();
}
public AuthenticationResponse authenticate(AuthenticationRequest request) {
// 這行會自動去資料庫比對密碼
authenticationManager.authenticate(
new UsernamePasswordAuthenticationToken(
request.getEmail(),
request.getPassword()
)
);
var user = repository.findByEmail(request.getEmail())
.orElseThrow();
var jwtToken = jwtService.generateToken(user);
return AuthenticationResponse.builder()
.token(jwtToken)
.build();
}
}

14
src/main/resources/application-dev.properties Normal file
View File

@@ -0,0 +1,14 @@
# ????? (????)
spring.datasource.url=jdbc:postgresql://localhost:58677/temp
spring.datasource.username=postgres
spring.datasource.password=Zaneanan0101+
spring.datasource.driver-class-name=org.postgresql.Driver
# JPA ???????????????? (?????)
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect
# Swagger??????????????
springdoc.api-docs.enabled=true
springdoc.swagger-ui.enabled=true

12
src/main/resources/application-prod.properties Normal file
View File

@@ -0,0 +1,12 @@
# ????? (???? - ????????????????)
spring.datasource.url=jdbc:postgresql://localhost:58677/temp
spring.datasource.username=postgres
spring.datasource.password=Zaneanan0101+
# JPA ???????????????????????????
spring.jpa.hibernate.ddl-auto=none
spring.jpa.show-sql=false
# Swagger?????????? API ??? (????????????)
springdoc.api-docs.enabled=false
springdoc.swagger-ui.enabled=false

15
src/main/resources/application.properties Normal file
View File

@@ -0,0 +1,15 @@
# ????
spring.application.name=bootTemplate
server.port=51888
# ?????? (????? dev??????? prod)
spring.profiles.active=dev
# Log ?? (??????)
logging.file.path=./logs
logging.file.name=${logging.file.path}/application.log
# Swagger ??????
springdoc.swagger-ui.path=/swagger-ui.html
springdoc.api-docs.path=/v3/api-docs
springdoc.writer-with-default-pretty-printer=true

45
src/main/resources/logback-spring.xml Normal file
View File

@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<springProperty scope="context" name="LOG_PATH" source="logging.file.path" defaultValue="./logs"/>
<springProperty scope="context" name="LOG_FILE" source="logging.file.name" defaultValue="./logs/application.log"/>
<property name="CONSOLE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %highlight(%-5level) [%thread] %cyan(%logger{36}) : %msg%n"/>
<property name="FILE_LOG_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{36} : %msg%n"/>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>${CONSOLE_LOG_PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${LOG_FILE}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>${LOG_PATH}/archived/application.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
<maxFileSize>100MB</maxFileSize>
<maxHistory>30</maxHistory>
<totalSizeCap>3GB</totalSizeCap>
</rollingPolicy>
<encoder>
<pattern>${FILE_LOG_PATTERN}</pattern>
<charset>UTF-8</charset>
</encoder>
</appender>
<logger name="org.hibernate.SQL" level="DEBUG"/>
<logger name="org.springframework.web" level="INFO"/>
<root level="INFO">
<appender-ref ref="CONSOLE" />
<appender-ref ref="FILE" />
</root>
</configuration>

13
src/test/java/com/boot/bootTemplate/BootTemplateApplicationTests.java Normal file
View File

@@ -0,0 +1,13 @@
package com.boot.bootTemplate;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class BootTemplateApplicationTests {
@Test
void contextLoads() {
}
}