Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 지역 검색 기능을 추가한다 #836

Merged
merged 15 commits into from
Oct 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 52 additions & 0 deletions backend/src/docs/asciidoc/admin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,55 @@ include::{snippets}/admin-member-controller-test/update-member-role/request-fiel
=== Response

include::{snippets}/admin-member-controller-test/update-member-role/http-response.adoc[]

== 도시를 모두 조회한다 (/admin/cities)

=== Request

include::{snippets}/admin-city-controller-test/find_all_cities/request-headers.adoc[]
include::{snippets}/admin-city-controller-test/find_all_cities/request-parameters.adoc[]
include::{snippets}/admin-city-controller-test/find_all_cities/http-request.adoc[]

=== Response

include::{snippets}/admin-city-controller-test/find_all_cities/response-fields.adoc[]
include::{snippets}/admin-city-controller-test/find_all_cities/http-response.adoc[]

== 도시를 저장한다 (/admin/cities)

=== Request

include::{snippets}/admin-city-controller-test/create_city/request-headers.adoc[]
include::{snippets}/admin-city-controller-test/create_city/request-fields.adoc[]
include::{snippets}/admin-city-controller-test/create_city/http-request.adoc[]

=== Response

include::{snippets}/admin-city-controller-test/create_city/response-fields.adoc[]
include::{snippets}/admin-city-controller-test/create_city/http-response.adoc[]

== 도시를 업데이트한다 (/admin/cities/{cityId})

=== Request

include::{snippets}/admin-city-controller-test/update_city/request-headers.adoc[]
include::{snippets}/admin-city-controller-test/update_city/path-parameters.adoc[]
include::{snippets}/admin-city-controller-test/update_city/request-fields.adoc[]
include::{snippets}/admin-city-controller-test/update_city/http-request.adoc[]

=== Response

include::{snippets}/admin-city-controller-test/update_city/response-fields.adoc[]
include::{snippets}/admin-city-controller-test/update_city/http-response.adoc[]

== 도시를 제거한다 (/admin/cities/{cityId})

=== Request

include::{snippets}/admin-city-controller-test/delete_city/request-headers.adoc[]
include::{snippets}/admin-city-controller-test/delete_city/path-parameters.adoc[]
include::{snippets}/admin-city-controller-test/delete_city/http-request.adoc[]

=== Response

include::{snippets}/admin-city-controller-test/delete_city/http-response.adoc[]
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
package com.carffeine.carffeine.admin.controller;

import com.carffeine.carffeine.admin.common.CustomPage;
import com.carffeine.carffeine.admin.controller.dto.CityResponse;
import com.carffeine.carffeine.admin.service.AdminCityService;
import com.carffeine.carffeine.admin.service.dto.CityCreateRequest;
import com.carffeine.carffeine.admin.service.dto.CityUpdateRequest;
import com.carffeine.carffeine.auth.controller.support.AuthMember;
import com.carffeine.carffeine.city.domain.City;
import lombok.RequiredArgsConstructor;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PatchMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RequiredArgsConstructor
@RequestMapping("/admin/cities")
@RestController
public class AdminCityController {

private final AdminCityService adminCityService;

@GetMapping
public ResponseEntity<CustomPage<CityResponse>> findAllCities(@AuthMember Long memberId, Pageable pageable) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

custom page 좋아요

Page<City> pagedCities = adminCityService.findAll(pageable, memberId);

int totalPage = pagedCities.getTotalPages();
List<CityResponse> cities = pagedCities.getContent()
.stream()
.map(CityResponse::from)
.toList();

return ResponseEntity.ok(new CustomPage<>(totalPage, cities));
}

@PostMapping
public ResponseEntity<CityResponse> saveNewCity(@AuthMember Long memberId, @RequestBody CityCreateRequest cityCreateRequest) {
City city = adminCityService.save(memberId, cityCreateRequest);
return ResponseEntity.status(HttpStatus.CREATED)
.body(CityResponse.from(city));
}

@PatchMapping("/{cityId}")
public ResponseEntity<CityResponse> updateCity(@AuthMember Long memberId,
@PathVariable Long cityId,
@RequestBody CityUpdateRequest cityUpdateRequest) {
City updatedCity = adminCityService.update(memberId, cityId, cityUpdateRequest);
return ResponseEntity.ok(CityResponse.from(updatedCity));
}

@DeleteMapping("/{cityId}")
public ResponseEntity<Void> deleteCity(@AuthMember Long memberId, @PathVariable Long cityId) {
adminCityService.deleteByCityId(memberId, cityId);
return ResponseEntity.noContent().build();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package com.carffeine.carffeine.admin.controller.dto;

import com.carffeine.carffeine.city.domain.City;

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

public record CitiesResponse(List<CityResponse> cities) {

public static CitiesResponse from(List<City> cities) {
return cities.stream()
.map(CityResponse::from)
.collect(Collectors.collectingAndThen(Collectors.toList(), CitiesResponse::new));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package com.carffeine.carffeine.admin.controller.dto;

import com.carffeine.carffeine.city.domain.City;

import java.math.BigDecimal;

public record CityResponse(Long id,
String name,
BigDecimal latitude,
BigDecimal longitude) {

public static CityResponse from(City city) {
return new CityResponse(
city.getId(),
city.getName(),
city.getLatitude().getValue(),
city.getLongitude().getValue()
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import com.carffeine.carffeine.common.exception.Status;

public enum AdminExceptionType implements ExceptionType {

NOT_ADMIN(Status.FORBIDDEN, 9001, "관리자가 아닙니다");

private final Status status;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
package com.carffeine.carffeine.admin.service;

import com.carffeine.carffeine.admin.exception.AdminException;
import com.carffeine.carffeine.admin.exception.AdminExceptionType;
import com.carffeine.carffeine.admin.service.dto.CityCreateRequest;
import com.carffeine.carffeine.admin.service.dto.CityUpdateRequest;
import com.carffeine.carffeine.member.domain.Member;
import com.carffeine.carffeine.member.domain.MemberRepository;
import com.carffeine.carffeine.city.domain.City;
import com.carffeine.carffeine.city.domain.CityRepository;
import com.carffeine.carffeine.station.domain.station.Latitude;
import com.carffeine.carffeine.station.domain.station.Longitude;
import com.carffeine.carffeine.city.exception.CityException;
import com.carffeine.carffeine.city.exception.CityExceptionType;
import lombok.RequiredArgsConstructor;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@RequiredArgsConstructor
@Service
public class AdminCityService {

private final MemberRepository memberRepository;
private final CityRepository cityRepository;

@Transactional(readOnly = true)
public Page<City> findAll(Pageable pageable, Long memberId) {
validateRole(memberId);
return cityRepository.findAll(pageable);
}

@Transactional
public City save(Long memberId, CityCreateRequest request) {
validateRole(memberId);

return cityRepository.save(new City(
request.name(),
Latitude.from(request.latitude()),
Longitude.from(request.longitude()))
);
}

@Transactional
public City update(Long memberId,
Long cityId,
CityUpdateRequest cityUpdateRequest) {
validateRole(memberId);
City city = findCity(cityId);
return city.update(cityUpdateRequest.name(), cityUpdateRequest.latitude(), cityUpdateRequest.longitude());
}

private void validateRole(Long memberId) {
memberRepository.findById(memberId)
.filter(Member::isAdmin)
.orElseThrow(() -> new AdminException(AdminExceptionType.NOT_ADMIN));
}

private City findCity(Long cityId) {
return cityRepository.findById(cityId)
.orElseThrow(() -> new CityException(CityExceptionType.NOT_FOUND));
}

@Transactional
public void deleteByCityId(Long memberId, Long cityId) {
validateRole(memberId);
cityRepository.deleteById(cityId);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package com.carffeine.carffeine.admin.service.dto;

import java.math.BigDecimal;

public record CityCreateRequest(String name,
BigDecimal longitude,
BigDecimal latitude) {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package com.carffeine.carffeine.admin.service.dto;

import java.math.BigDecimal;

public record CityUpdateRequest(String name,
BigDecimal latitude,
BigDecimal longitude) {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
package com.carffeine.carffeine.city.domain;

import com.carffeine.carffeine.station.domain.station.Latitude;
import com.carffeine.carffeine.station.domain.station.Longitude;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;

import javax.persistence.Column;
import javax.persistence.Embedded;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
import java.math.BigDecimal;

@Getter
@Builder
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@NoArgsConstructor(access = AccessLevel.PROTECTED)
@EqualsAndHashCode(of = "id", callSuper = false)
@Entity
@Table(name = "city")
public class City {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

@Column(nullable = false)
private String name;

@Embedded
private Latitude latitude;

@Embedded
private Longitude longitude;

public City(String name, Latitude latitude, Longitude longitude) {
this.name = name;
this.latitude = latitude;
this.longitude = longitude;
}

public City update(String name, BigDecimal latitude, BigDecimal longitude) {
this.name = name;
this.latitude = Latitude.from(latitude);
this.longitude = Longitude.from(longitude);
return this;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package com.carffeine.carffeine.city.domain;

import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.repository.Repository;

import java.util.Optional;

public interface CityRepository extends Repository<City, Long> {

Page<City> findAll(Pageable pageable);

Optional<City> findById(Long id);

City save(City city);

void deleteById(Long id);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package com.carffeine.carffeine.city.exception;

import com.carffeine.carffeine.common.exception.BaseException;
import com.carffeine.carffeine.common.exception.ExceptionType;

public class CityException extends BaseException {

public CityException(final ExceptionType exceptionType) {
super(exceptionType);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package com.carffeine.carffeine.city.exception;

import com.carffeine.carffeine.common.exception.ExceptionType;
import com.carffeine.carffeine.common.exception.Status;

public enum CityExceptionType implements ExceptionType {

NOT_FOUND(Status.NOT_FOUND, 10001, "요청하신 도시를 찾을 수 없습니다.");

private final Status status;
private final int exceptionCode;
private final String message;

CityExceptionType(Status status, int exceptionCode, String message) {
this.status = status;
this.exceptionCode = exceptionCode;
this.message = message;
}

@Override
public Status status() {
return status;
}

@Override
public int exceptionCode() {
return exceptionCode;
}

@Override
public String message() {
return message;
}
}