CRM 프로젝트의 백엔드 개발 과정에서 전역 예외 처리와 권한 부족 예외 처리 간의 충돌 문제를 해결하고, 모든 API 요청에 대해 적절한 권한 부여를 적용하는 방법을 설명합니다.
1. 전역 예외 처리
@RestControllerAdvice를 사용하여 애플리케이션 전반의 예외를 중앙에서 처리합니다. 이를 통해 코드 중복을 줄이고 일관된 오류 응답을 제공할 수 있습니다.
GlobalExceptionHandler.java
package com.alatus.config.handler;
import com.alatus.result.CodeEnum;
import com.alatus.result.Result;
import org.springframework.dao.DataAccessException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
/**
* 전역 예외 처리기
*/
@RestControllerAdvice
public class GlobalExceptionHandler {
/**
* 일반 예외 처리
* @param e 발생한 예외
* @return 결과 객체
*/
@ExceptionHandler(value = Exception.class)
public Result handleGeneralException(Exception e) {
e.printStackTrace(); // 콘솔에 예외 스택 트레이스 출력
// 권한 부족 예외 메시지 ("Access Denied") 특정 처리
if("Access Denied".equals(e.getMessage())) {
return Result.FAIL(CodeEnum.ACCESS_DENIED);
} else {
// 기타 일반 예외는 메시지를 그대로 반환
return Result.FAIL(e.getMessage());
}
}
/**
* 데이터 접근 예외 처리 (DB 관련)
* @param e 발생한 데이터 접근 예외
* @return 결과 객체
*/
@ExceptionHandler(value = DataAccessException.class)
public Result handleDataAccessException(DataAccessException e) {
e.printStackTrace();
return Result.FAIL(CodeEnum.DATA_ACCESS_EXCEPTION);
}
}
위 코드는 모든 Exception과 DataAccessException을 처리합니다. 특히 "Access Denied" 메시지를 가진 예외는 ACCESS_DENIED 코드로 응답하도록 분기 처리하여, 스프링 시큐리티에서 발생하는 권한 부족 예외를 명확히 구분합니다.
2. 권한 부족 예외 핸들러
스프링 시큐리티의 접근 거부 처리를 위한 커스텀 핸들러를 구현합니다. 이는 GlobalExceptionHandler와 별개로 동작하며, 주로 인증된 사용자가 특정 리소스에 접근할 권한이 없을 때 호출됩니다.
MyAccessDeniedHandler.java
package com.alatus.config.handler;
import com.alatus.result.CodeEnum;
import com.alatus.result.Result;
import com.alatus.util.JSONUtils; // JSON 변환 유틸리티 (가정)
import com.alatus.util.ResponseUtils; // 응답 유틸리티 (가정)
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.security.web.access.AccessDeniedHandler;
import org.springframework.stereotype.Component;
import java.io.IOException;
@Component
public class MyAccessDeniedHandler implements AccessDeniedHandler {
@Override
public void handle(HttpServletRequest request, HttpServletResponse response, AccessDeniedException accessDeniedException) throws IOException, ServletException {
// 이 지점에 도달했다면 사용자는 인증되었으나 권한이 부족한 경우입니다.
// 클라이언트에게 JSON 형식으로 응답합니다.
Result errorResponse = Result.FAIL(CodeEnum.ACCESS_DENIED);
// Result 객체를 JSON 문자열로 변환 (JSONUtils는 별도 구현 필요)
String jsonResponse = JSONUtils.toJSON(errorResponse);
// HttpServletResponse에 JSON 응답 작성 (ResponseUtils는 별도 구현 필요)
ResponseUtils.write(response, jsonResponse);
}
}
이 핸들러는 AccessDeniedException이 발생했을 때 호출되며, GlobalExceptionHandler의 일반 예외 처리 로직보다 우선적으로 적용될 수 있습니다. 이를 통해 권한 부족에 대한 명확하고 표준화된 JSON 응답을 보장합니다. JSONUtils와 ResponseUtils는 실제 프로젝트에 맞게 구현해야 하는 유틸리티 클래스입니다.
3. API 컨트롤러 및 권한 부여
각 컨트롤러의 메서드에 @PreAuthorize 어노테이션을 사용하여 필요한 권한을 명시합니다. 이는 Spring Security가 요청을 처리하기 전에 권한을 검증하도록 합니다.
UserController.java (사용자 관리)
package com.alatus.web;
import com.alatus.constant.Constants;
import com.alatus.model.TUser;
import com.alatus.query.UserQuery;
import com.alatus.result.Result;
import com.alatus.service.UserService;
import com.github.pagehelper.PageInfo;
import jakarta.annotation.Resource;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.security.core.Authentication;
import org.springframework.web.bind.annotation.*;
import java.util.Arrays;
import java.util.List;
@RestController
public class UserController {
@Resource
private UserService userService;
@GetMapping(value = "/api/login/info")
public Result loginInfo(Authentication authentication) {
TUser currentUser = (TUser) authentication.getPrincipal();
return Result.OK(currentUser);
}
@GetMapping(value = "/api/login/free")
public Result freeLogin() {
// 이 엔드포인트는 인증 필터를 통과했음을 의미하므로, 성공 응답 반환
return Result.OK();
}
@PreAuthorize(value = "hasAuthority('user:list')") // 사용자 목록 조회 권한
@GetMapping(value = "/api/users")
public Result userPage(@RequestParam(value = Constants.CURRENT, required = false) Integer pageNum) {
int currentPage = (pageNum == null) ? 1 : pageNum;
PageInfo<TUser> userPage = userService.getUserByPage(currentPage);
return Result.OK(userPage);
}
@PreAuthorize(value = "hasAuthority('user:view')") // 사용자 상세 조회 권한
@GetMapping(value = "/api/user/{userId}")
public Result userDetail(@PathVariable(value = Constants.ID) Integer userId) {
TUser user = userService.getUserById(userId);
return Result.OK(user);
}
@PreAuthorize(value = "hasAuthority('user:add')") // 사용자 추가 권한
@PostMapping(value = "/api/user/add")
public Result addUser(UserQuery userDto, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
userDto.setToken(token);
int affectedRows = userService.saveUser(userDto);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('user:edit')") // 사용자 수정 권한
@PutMapping(value = "/api/user/edit")
public Result editUser(UserQuery userDto, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
userDto.setToken(token);
int affectedRows = userService.updateUser(userDto);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('user:delete')") // 사용자 삭제 권한
@DeleteMapping(value = "/api/user/del/{userId}")
public Result deleteUser(@PathVariable(value = Constants.ID) Integer userId, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
int affectedRows = userService.delUserById(userId);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('user:delete')") // 사용자 일괄 삭제 권한
@DeleteMapping(value = "/api/user/batchDel")
public Result batchDeleteUsers(@RequestParam(value = Constants.IDS) String idString, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
List<String> idList = Arrays.asList(idString.split(","));
int affectedRows = userService.delUsersByIds(idList);
return affectedRows == idList.size() ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('clue:view')") // 활동 소유자 조회 권한
@GetMapping(value = "/api/user/activityOwner")
public Result loadActivityOwners() {
return Result.OK(userService.getOwnerList());
}
}
ClueController.java (잠재 고객 관리)
package com.alatus.web;
import com.alatus.constant.Constants;
import com.alatus.model.TClue;
import com.alatus.query.ClueQuery;
import com.alatus.result.Result;
import com.alatus.service.ClueService;
import com.github.pagehelper.PageInfo;
import jakarta.annotation.Resource;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
@RestController
public class ClueController {
@Resource
private ClueService clueService;
@PreAuthorize(value = "hasAuthority('clue:list')") // 잠재 고객 목록 조회 권한
@GetMapping(value = "/api/clues")
public Result cluePage(@RequestParam(value = Constants.CURRENT, required = false) Integer pageNum) {
int currentPage = (pageNum == null) ? 1 : pageNum;
PageInfo<TClue> pageInfo = clueService.getClueByPage(currentPage);
return Result.OK(pageInfo);
}
@PreAuthorize(value = "hasAuthority('clue:import')") // 엑셀 파일 가져오기 권한
@PostMapping(value = "/api/clue/importExcel")
public Result importExcel(MultipartFile file, @RequestHeader(value = Constants.TOKEN_NAME) String token) throws IOException {
clueService.importExcel(file.getInputStream(), token);
return Result.OK();
}
@PreAuthorize(value = "hasAuthority('clue:delete')") // 잠재 고객 단일 삭제 권한
@DeleteMapping(value = "/api/clue/delete/{clueId}")
public Result deleteClue(@PathVariable(value = Constants.ID) Integer clueId) {
Integer affectedRows = clueService.deleteClue(clueId);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('clue:delete')") // 잠재 고객 일괄 삭제 권한
@DeleteMapping(value = "/api/clue/batchDel")
public Result batchDeleteClue(@RequestParam(value = Constants.IDS) String idString, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
List<String> idList = Arrays.asList(idString.split(","));
int affectedRows = clueService.delClueByIds(idList);
return affectedRows == idList.size() ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('clue:view')") // 전화번호 중복 확인 권한
@GetMapping(value = "/api/clue/phone/{phoneNumber}")
public Result checkPhoneNumber(@PathVariable(value = Constants.PHONE) String phoneNumber) {
Boolean exists = clueService.checkPhone(phoneNumber);
return exists ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('clue:add')") // 잠재 고객 추가 권한
@PostMapping(value = "/api/clue/add")
public Result addClue(@RequestHeader(value = Constants.TOKEN_NAME) String token, ClueQuery clueDto) {
clueDto.setToken(token);
int affectedRows = clueService.saveClue(clueDto);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('clue:view')") // 잠재 고객 상세 조회 권한
@GetMapping(value = "/api/clue/{clueId}")
public Result getClue(@PathVariable(value = Constants.ID) Integer clueId) {
TClue clue = clueService.getClueById(clueId);
return Result.OK(clue);
}
@PreAuthorize(value = "hasAuthority('clue:edit')") // 잠재 고객 수정 권한
@PutMapping(value = "/api/clue/edit")
public Result editClue(@RequestHeader(value = Constants.TOKEN_NAME) String token, ClueQuery clueDto) {
clueDto.setToken(token);
int affectedRows = clueService.editClue(clueDto);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
}
ActivityController.java (활동 관리)
package com.alatus.web;
import com.alatus.constant.Constants;
import com.alatus.model.TActivity;
import com.alatus.query.ActivityQuery;
import com.alatus.result.Result;
import com.alatus.service.ActivityService;
import com.github.pagehelper.PageInfo;
import jakarta.annotation.Resource;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;
import java.util.Arrays;
import java.util.List;
@RestController
public class ActivityController {
@Resource
private ActivityService activityService;
@PreAuthorize(value = "hasAuthority('activity:list')") // 활동 목록 조회 권한
@GetMapping(value = "/api/activities")
public Result activityPage(@RequestParam(value = Constants.CURRENT, required = false) Integer pageNum,
ActivityQuery activityDto) {
int currentPage = (pageNum == null) ? 1 : pageNum;
PageInfo<TActivity> activityPage = activityService.getActivityByPage(currentPage, activityDto);
return Result.OK(activityPage);
}
@PreAuthorize(value = "hasAuthority('activity:add')") // 활동 추가 권한
@PostMapping(value = "/api/activity/add")
public Result addActivity(ActivityQuery activityDto, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
activityDto.setToken(token);
int affectedRows = activityService.saveActivity(activityDto);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('activity:delete')") // 활동 단일 삭제 권한
@DeleteMapping(value = "/api/activity/delete/{activityId}")
public Result deleteActivity(@PathVariable(value = Constants.ID) Integer activityId) {
int affectedRows = activityService.deleteActivtyById(activityId);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('activity:view')") // 활동 상세 조회 권한
@GetMapping(value = "/api/activity/{activityId}")
public Result activityDetail(@PathVariable(value = Constants.ID) Integer activityId) {
TActivity activity = activityService.getActivityById(activityId);
return Result.OK(activity);
}
@PreAuthorize(value = "hasAuthority('activity:delete')") // 활동 일괄 삭제 권한
@DeleteMapping(value = "/api/activity/batchDel")
public Result activityBatchDelete(@RequestParam(value = Constants.IDS) String idString, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
List<String> idList = Arrays.asList(idString.split(","));
int affectedRows = activityService.delActivityByIds(idList);
return affectedRows == idList.size() ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('activity:edit')") // 활동 수정 권한
@PutMapping(value = "/api/activity/edit")
public Result editActivity(ActivityQuery activityDto, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
activityDto.setToken(token);
int affectedRows = activityService.updateActivity(activityDto);
return affectedRows >= 1 ? Result.OK() : Result.FAIL();
}
}
CustomerController.java (고객 관리)
package com.alatus.web;
import com.alatus.constant.Constants;
import com.alatus.model.TCustomer;
import com.alatus.query.CustomerQuery;
import com.alatus.result.CustomerExcel; // Excel 내보내기용 DTO (가정)
import com.alatus.result.Result;
import com.alatus.service.CustomerService;
import com.alibaba.excel.EasyExcel; // EasyExcel 라이브러리 사용
import com.github.pagehelper.PageInfo;
import jakarta.annotation.Resource;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.util.ObjectUtils;
import org.springframework.web.bind.annotation.*;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.Arrays;
import java.util.List;
@RestController
public class CustomerController {
@Resource
private CustomerService customerService;
@PostMapping(value = "/api/clue/customer") // 잠재 고객에서 고객으로 전환
public Result transferCustomer(@RequestBody CustomerQuery customerDto, @RequestHeader(value = Constants.TOKEN_NAME) String token) {
customerDto.setToken(token);
Boolean converted = customerService.convertCustomer(customerDto);
return converted ? Result.OK() : Result.FAIL();
}
@PreAuthorize(value = "hasAuthority('customer:list')") // 고객 목록 조회 권한
@GetMapping(value = "/api/customers")
public Result customersByPages(@RequestParam(value = Constants.CURRENT, required = false) Integer pageNum) {
int currentPage = (pageNum == null) ? 1 : pageNum;
PageInfo<TCustomer> pageInfo = customerService.getCustomerByPage(currentPage);
return Result.OK(pageInfo);
}
@PreAuthorize(value = "hasAuthority('customer:export')") // 고객 엑셀 내보내기 권한
@GetMapping(value = "/api/exportExcel")
public void exportExcel(@RequestParam(value = Constants.IDS, required = false) String idString, HttpServletResponse response) throws IOException {
List<String> idList = null;
if (!ObjectUtils.isEmpty(idString)) {
idList = Arrays.asList(idString.split(","));
}
// 다운로드 응답 설정
response.setContentType("application/octet-stream");
response.setCharacterEncoding(Constants.UTF_8);
// IFrame 보안 문제 해결 헤더 (필요시 사용)
// response.setHeader("X-Frame-Options", "allow-from uri");
String filename = URLEncoder.encode(Constants.CUSTOMER_FILE_NAME + System.currentTimeMillis(), Constants.UTF_8) + ".xlsx";
response.setHeader("Content-disposition", "attachment;filename=" + filename);
List<CustomerExcel> dataForExport = customerService.getCustomerDataForExcel(idList);
EasyExcel.write(response.getOutputStream(), CustomerExcel.class)
.sheet("Customers") // 시트 이름 설정
.doWrite(dataForExport);
}
}
각 컨트롤러 클래스 상단에 @RestController가 적용되어 있고, 각 API 엔드포인트 메서드에는 @GetMapping, @PostMapping, @PutMapping, @DeleteMapping 등의 HTTP 메서드 어노테이션과 함께 @PreAuthorize를 사용하여 필요한 권한을 명시했습니다. 예를 들어, hasAuthority('user:list')는 해당 API에 접근하기 위해 'user:list' 권한이 필요함을 의미합니다.