package com.acorn.response;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;

/**
 * 만약 REST API 응답에서 에러가 발생했을 시 프론트엔드쪽에서도 에러 발생 원인을 좀 더 쉽게 
 * 파악하기 위해 정형화된 응답 데이터 구조를 정의함. 
 * 
 * @author JeroCaller
 */
@Getter
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class ResponseJson {
	
	private HttpStatus status;
	private String message;
	private Object data;
	
	/**
	 * 현재 ResponseJson 객체를 ResponseEntity 객체로 변환.
	 * 
	 * @author JeroCaller
	 * @return
	 */
	public ResponseEntity<ResponseJson> toResponseEntity() {
		return ResponseEntity
				.status(this.status)
				.body(this);
	}
	
}

package com.acorn.controller;

import java.util.List;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.acorn.dto.CategoryGroupsFilterDto;
import com.acorn.process.CategoryProcess;
import com.acorn.response.ResponseJson;
import com.acorn.response.ResponseStatusMessages;

import lombok.RequiredArgsConstructor;

@RestController
@RequestMapping("/main/categories/filter")
@RequiredArgsConstructor
public class CategoryController {
	
	private final CategoryProcess categoryProcess;
	
	/**
	 * 모든 음식점 카테고리 (대분류, 중분류 포함) 정보 응답.
	 * 음식점 카테고리 대분류 DTO 내부에 카테고리 소분류 DTO가 포함되어 있는 구조.
	 * 
	 * @author JeroCaller
	 * @return
	 */
	@GetMapping("")
	public ResponseEntity<ResponseJson> getCategoryAll() {
		ResponseJson responseJson = null;
		
		List<CategoryGroupsFilterDto> categoryGroupsFilterDtos 
			= categoryProcess.getAllCategoryGroups();
		if (categoryGroupsFilterDtos.size() == 0) {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.NOT_FOUND)
					.message(ResponseStatusMessages.NO_DATA_FOUND)
					.build();
		} else {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.OK)
					.message(ResponseStatusMessages.READ_SUCCESS)
					.data(categoryGroupsFilterDtos)
					.build();
		}
		
		return responseJson.toResponseEntity();
	}
	
}

package com.acorn.response;

/**
 * 응답 데이터로 HTTP 응답 상태를 상세히 설명한 메시지를 포함시키기 위한 용도.
 * 프론트엔드 단에서 응답 성공 및 실패 이유를 추측할 수 있게 하기 위함. 
 * 
 * 여기서는 일반적인 상황에서의 메시지를 담고 있으므로 특수한 상황에서의 메시지 필요 시 
 * 별도의 인터페이스 (또는 커스텀 예외 클래스 등)를 정의하여 메시지 정의하면 됨. 
 * 
 * 구현 강제 용도 X
 * 
 * @author JeroCaller 
 */
public interface ResponseStatusMessages {
	
	String NO_DATA_FOUND = "조회된 데이터가 없습니다.";
	String READ_SUCCESS = "데이터 조회 성공.";
	
	String CREATE_SUCCESS = "데이터 삽입 성공.";
	String CREATE_FAILED = "데이터 삽입 실패.";
	
	String UPDATE_SUCCESS = "데이터 변경 성공.";
	String UPDATE_FAILED = "데이터 변경 실패.";
	
	String DELETE_SUCCESS = "데이터 삭제 성공.";
	String DELETE_FAILED = "데이터 삭제 실패.";
	
	String NO_REQUEST_ARGS = "입력된 요청 인자 없음.";
	
	String AUTHORIZED_MEMBER = "인증된 사용자입니다.";
	String UNAUTHORIZED_MEMBER 
		= "비로그인 또는 인증되지 않은 사용자입니다. 미인증 사용자에게는 제공되지 않는 기능입니다.";
	
}

/**
	 * 지역 및 음식 카테고리 대분류 두 검색 조건이 적용되어 검색된 음식점 정보들을 반환.
	 * 
	 * 예를 들어 지역: 서울, 카테고리: 한식 입력 시 서울 지역 내 한식 카테고리에 해당하는 
	 * 모든 음식점 정보들을 페이징하여 반환.
	 * 
	 * @author JeroCaller
	 * @param location - 문자열 형태의 지역 주소명
	 * @param largeId - 카테고리 대분류 엔티티의 ID
	 * @param page
	 * @param size
	 * @return
	 */
	@GetMapping("/{location}/categories/large/{lid}")
	public ResponseEntity<ResponseJson> getEateriesByLocationAndCategoryLarge(
			@PathVariable(name = "location") String location,
			@PathVariable(name = "lid") int largeId,
			@RequestParam(name = "page", defaultValue = "1") int page,
			@RequestParam(name = "size", defaultValue = "10") int size
	) {
		ResponseJson responseJson = null;
		
		Pageable pageRequest = PageUtil.getPageRequestOf(page, size);
		Page<EateriesDto> eateries = null;
		try {
			eateries = eateriesMainProcess
					.getEateriesByLocationAndCategoryLarge(
							location, 
							largeId, 
							pageRequest
					);
		} catch (NoCategoryFoundException e) {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.NOT_FOUND)
					.message(e.getMessage())
					.build();
			return responseJson.toResponseEntity();
		}
		
		// 클라이언트가 전달한 지역 주소에 해당하는 음식점 데이터가 없는 경우.
		if (PageUtil.isEmtpy(eateries)) {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.NOT_FOUND)
					.message(ResponseStatusMessages.NO_DATA_FOUND)
					.build();
		} else {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.OK)
					.message(ResponseStatusMessages.READ_SUCCESS)
					.data(eateries)
					.build();
		}
		
		return responseJson.toResponseEntity();
	}

/**
	 * 지역 및 카테고리 대분류 ID(PK) 검색 조건에 해당하는 음식점 정보 조회 및 반환
	 * 
	 * @author JeroCaller 
	 * @param location - 문자열 형태의 지역 주소명
	 * @param largeId - 카테고리 대분류 엔티티의 ID
	 * @param pageRequset
	 * @return
	 * @throws NoCategoryFoundException 입력된 카테고리 대분류 ID(largeId)가 DB 
	 * 내에 조회되지 않은 경우 발생.
	 */
	// 각자 다른 repository로부터 조회하는 코드가 있으므로 이를 트랜잭션으로 묶는 게 
	// 좋을 것 같다는 판단 하에 @Transactional 어노테이션 부여함.
	@Transactional(readOnly = true)
	public Page<EateriesDto> getEateriesByLocationAndCategoryLarge(
			String location,
			int largeId,
			Pageable pageRequset
	) throws NoCategoryFoundException {
		Optional<CategoryGroups> categoryGroupOpt = categoryGroupsRepository
				.findById(largeId);

		CategoryGroups categoryGroups = categoryGroupOpt.orElseThrow(
				() -> new NoCategoryFoundException(
						"카테고리 대분류 ID: " + String.valueOf(largeId)
					)
		);
		
		Page<Eateries> eateries = eateriesRepository.findByCategoryGroup(
				location, 
				categoryGroups.getNo(), 
				pageRequset
		);
		
		return eateries.map(EateriesDto :: toDto);
	}

package com.acorn.exception.category;

/**
 * 조회된 카테고리가 없을 때 발생시킬 커스텀 예외 클래스. 
 * 
 * RuntimeException을 상속받도록 하면 메서드 선언부에 throws를 추가하라는 
 * 이클립스 자동 기능이 제공되지 않음. 이를 위해 Exception을 대신 상속받도록 함.
 * 
 * @author JeroCaller
 */
public class NoCategoryFoundException extends Exception {
	
	public NoCategoryFoundException(String input) {
		super("해당 카테고리 조회 결과가 없습니다. 입력한 카테고리 관련 정보: " + input);
	}
	
}

/**
	 * 사용자 맞춤 추천 음식점 정보 반환
	 * 
	 * 추천 알고리즘
	 * - 사용자 (로그인한 상황 가정) 즐겨찾기한 음식점 목록 추린 후, 
	 * 음식점 목록 내 같은 카테고리의 다른 음식점 조회하여 반환.
	 * 
	 * @author JeroCaller
	 * @return
	 */
	@GetMapping("/eateries/recommends")
	public ResponseEntity<ResponseJson> getEateriesForMember(
			@RequestParam(name = "page", defaultValue = "1") int page, 
			@RequestParam(name = "size", defaultValue = "10") int size
	) {
		
		ResponseJson responseJson = null;
		ResponseJson memberJson = getMemberInfo();
			
		// 생략...
			
		Pageable pageRequest = PageUtil.getPageRequestOf(page, size);
		MembersResponseDto memberInfo = (MembersResponseDto) memberJson.getData();
			
		Page<EateriesDto> eateries = null;
		boolean isException = true;
		try {
			eateries = memberEateriesProcess.getEateriesByRecommend(
						memberInfo.getNo() , 
						pageRequest
			);
			isException = false;
		} catch (NoMemberFoundException e) {
			// 미인증된 사용자로 판별
			responseJson = ResponseJson.builder()
					.status(HttpStatus.UNAUTHORIZED)
					.message(e.getMessage())
					.build();
		} catch ( NoCategoryFoundException | NoEateriesFoundException e) {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.NOT_FOUND)
					.message(e.getMessage())
					.build();
		}
			
		if (!isException) {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.OK)
					.message(ResponseStatusMessages.READ_SUCCESS)
					.data(eateries)
					.build();
		}
			
		return responseJson.toResponseEntity();
		
	}

/**
	 * 현재 사용자가 즐겨찾기한 음식점들의 카테고리와 동일한 카테고리를 가지는 모든 
	 * 음식점들을 가져와 반환한다.
	 * 
	 * @author JeroCaller
	 * @param memberNo
	 * @return
	 * @throws NoMemberFoundException 
	 * @throws NoCategoryFoundException 
	 * @throws NoEateriesFoundException 
	 */
	// 여러 엔티티를 조회하므로 이 작업들을 하나의 트랙잭션으로 묶음
	// 또한 readOnly = true로 할 시 조회 과정만 있음을 명시할 수 있을 뿐만 아니라 
	// 조회 과정의 속도가 더 빨라진다고 한다.
	@Transactional(readOnly = true)  
	public Page<EateriesDto> getEateriesByRecommend(
			int memberNo, 
			Pageable pageRequest
	) throws NoMemberFoundException, 
		NoCategoryFoundException, 
		NoEateriesFoundException 
	{
		
		// 멤버 ID에 해당하는 멤버 엔티티 조회.
		Optional<Members> membersOpt = membersRepository.findById(memberNo);
		Members member = membersOpt.orElseThrow(
				() -> new NoMemberFoundException(String.valueOf(memberNo))
		);
		
		/*
		log.info("현재 로그인 사용자 정보");
		log.info("이메일 : " + member.getEmail());
		log.info("ID 번호: " + member.getNo());
		*/

		List<Categories> memberCategories = categoriesRepository
				.findByMemberFavorite(member);
		if (ListUtil.isEmpty(memberCategories)) {
			throw new NoCategoryFoundException("사용자가 즐겨찾기한 음식점이 없는 듯 합니다.");
		}
		
		/*
		log.info("사용자가 즐겨찾기한 음식점들의 카테고리 정보");
		memberCategories.forEach(cate -> {
			log.info("카테고리 대분류 번호: " + cate.getGroup().getNo());
			log.info("카테고리 소분류 번호: " + cate.getNo());
			log.info("카테고리 명: " + cate.getGroup().getName() + " " + cate.getName());
			log.info("-----------------");
		}); */
		
		Page<Eateries> eateries = eateriesRepository
				.findByCategoryIn(memberCategories, pageRequest);
		
		if (PageUtil.isEmtpy(eateries)) {
			throw new NoEateriesFoundException();
		}
		
		return eateries.map(EateriesDto :: toDto);
	}

package com.acorn.controller;

import java.util.List;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.acorn.dto.CategoryGroupsFilterDto;
import com.acorn.process.CategoryProcess;
import com.acorn.response.ResponseJson;
import com.acorn.response.ResponseStatusMessages;

import lombok.RequiredArgsConstructor;

@RestController
@RequestMapping("/main/categories/filter")
@RequiredArgsConstructor
public class CategoryController {
	
	private final CategoryProcess categoryProcess;
	
	/**
	 * 모든 음식점 카테고리 (대분류, 중분류 포함) 정보 응답.
	 * 음식점 카테고리 대분류 DTO 내부에 카테고리 소분류 DTO가 포함되어 있는 구조.
	 * 
	 * @author JeroCaller
	 * @return
	 */
	@GetMapping("")
	public ResponseEntity<ResponseJson> getCategoryAll() {
		ResponseJson responseJson = null;
		
		List<CategoryGroupsFilterDto> categoryGroupsFilterDtos 
			= categoryProcess.getAllCategoryGroups();
		if (categoryGroupsFilterDtos.size() == 0) {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.NOT_FOUND)
					.message(ResponseStatusMessages.NO_DATA_FOUND)
					.build();
		} else {
			responseJson = ResponseJson.builder()
					.status(HttpStatus.OK)
					.message(ResponseStatusMessages.READ_SUCCESS)
					.data(categoryGroupsFilterDtos)
					.build();
		}
		
		return responseJson.toResponseEntity();
	}
	
}

package com.acorn.process;

import java.util.List;
import java.util.stream.Collectors;

import org.springframework.stereotype.Service;

import com.acorn.dto.CategoryGroupsFilterDto;
import com.acorn.entity.CategoryGroups;
import com.acorn.repository.CategoryGroupsRepository;

import lombok.RequiredArgsConstructor;

@Service
@RequiredArgsConstructor
public class CategoryProcess {

	private final CategoryGroupsRepository categoryGroupsRepository;
	
	/**
	 * 모든 카테고리 대분류를 반환. 카테고리 대분류 내부에 소분류 포함되어 반환.
	 * 
	 * @author JeroCaller 
	 * @return
	 */
	public List<CategoryGroupsFilterDto> getAllCategoryGroups() {
		List<CategoryGroups> result = categoryGroupsRepository
				.findAll();
		
		return result.stream()
				.map(CategoryGroupsFilterDto :: toDto)
				.collect(Collectors.toList());
	}
	
}

@GetMapping(value = "/local/search/keyword.json")
KeywordResponseDto getEateriesByKeyword(@SpringQueryMap KeywordRequestDto requestDto);