Login Service[1] security 회원가입

최준호·2022년 3월 17일

jayeon

목록 보기

7/10

🔨Project 생성

추후에 Kafka와 RabbitMQ와 같은 설정도 추가할거지만 그건 그때 생각하고 우선 당장에 사용할거 같은 의존성만 추가해봤다. 생각보다 많다...ㅎ

@SpringBootApplication
@EnableDiscoveryClient
public class LoginServiceApplication {

	public static void main(String[] args) {
		SpringApplication.run(LoginServiceApplication.class, args);
	}

}

Eureka에 등록되도록 @EnableDiscoveryClient를 추가해주고

server:
  port: 0 #랜덤으로 포트 설정

spring:
  application:
    name: login-service  #Eureka에 등록되는 서비스 이름
eureka:
  instance:
    instance-id: ${spring.application.name}:${spring.application.instance_id:${random.value}}  #포트가 중복으로 설정되어 구분하기 위한 인스턴스 아이디 값 설정
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://127.0.0.1:8761/eureka

다음 설정 내용을 config server git에 올려놓자 or application.yml에 그대로 등록해도 된다.

application.yml

server:
  port: 0 #랜덤으로 포트 설정

spring:
  application:
    name: login-service  #Eureka에 등록되는 서비스 이름

eureka:
  instance:
    instance-id: ${spring.application.name}:${spring.application.instance_id:${random.value}}  #포트가 중복으로 설정되어 구분하기 위한 인스턴스 아이디 값 설정

bootstrap.yml

eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://127.0.0.1:8761/eureka

bootstrap을 사용할 경우 다음과 같이 설정해준다.

implementation 'org.springframework.cloud:spring-cloud-starter-bootstrap'
implementation 'org.springframework.boot:spring-boot-starter-actuator'
spring initialization으로 만들었던 프로젝트에서 정상 작동을 하지 않아서 다음 의존성을 더 추가해주었다.

config의 경우 ${}과 같이 변수?를 받아오는 작업은 정상적으로 진행되지 않더라. config쪽에서 받아오는 정보는 최대한 고정값이 정해진 값으로만 받고 나머지는 application config로 실행하자.

설정과 함께 잘 등록된 것을 볼수 있다.

열려진 포트로 접속하면 security 설정으로 인해 모든 접근이 막혀있다. 이제 이걸 우리가 설정해보자.

🔨Security 설정

runtimeOnly 'com.h2database:h2:1.3.176'

우선은 h2로 테스트 진행할 것이므로 1.3.176으로 사용하자 왜냐하면 이 상위버전은 오류가 발생하는데 그걸 해결하면서 진행하려면 시간 더 걸린다 그냥 1.3.176으로 쓰자

spring:
  h2:
    console:
      enabled: true
      settings:
        web-allow-others: true
      path: /h2-console
  datasource:
    driver-class-name: org.h2.Driver
    url: jdbc:h2:mem:testdb
    username: sa
    password:

다음 설정값을 application.yml에 설정해준다. bootstrap에 설정해주려고 하니 web-allow-others 에러가 발생한다.

@Configuration
@EnableWebSecurity
public class WebSecurity extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.csrf().disable();
        http.authorizeRequests().antMatchers("/**").permitAll();

        http.headers().frameOptions().disable();    //h2 error
    }
}

그 후 다음과 같이 security 설정을 통해 모든 url에 우선 접근이 가능하도록 풀어놓자. 그 후에 차차 접근 권한을 설정해둘거다.

잘 접근이 된다.

🔨Controller Test

Controller에서 테스트하기 위해 port가 찍혀 나오는 url을 하나 만들어보자

@RestController
@RequestMapping(value = "/")
@RequiredArgsConstructor
public class HelloController {

    private final Environment env;

    @GetMapping("check")
    public ResponseEntity<String> check(){

        return ResponseEntity.ok().body(String.format("hello Login Service Port = %s", env.getProperty("local.server.port")));
    }
}

포트에 직접 들어가서 check로 요청하면 다음과 같이 정상 요청이 된다.

이제 gateway를 연결해서 사용해보자.

server:
  port: 8000

eureka:
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      defaultZone: http://127.0.0.1:8761/eureka

spring:
  application:  #gateway service 이름름
    name: gateway-service
  cloud:
    gateway:  #gateway 설정
      routes:
        - id: login-service	#Service id
          uri: lb://LOGIN-SERVICE	#Eureka에 등록된 Service 이름
          predicates:
            - Path=/login-service/**	#구분될 url
            - Method=GET, POST			#요청 가능한 Method
          filters:
            - RemoveRequestHeader=Cookie
            - RewritePath=/login-service(?<segment>.*), /$\{segment}	#들어온 요청에 대해 자동으로 /login-service/를 붙여서 실행

config에 설정해놨던 gateway의 yml파일을 다음과 같이 수정해주었다.

재실행 하느라 포트가 변경되었지만 이제 gateway로 요청할 수 있게 되었다.

🔨User 등록 서비스 만들기

로그인 기능을 만들기 전에 우선 회원가입을 통해 User의 정보를 등록할 User Entity를 만들어두려고 한다.

@Table(name = "USERS")
@Entity
@Getter
@AllArgsConstructor
@NoArgsConstructor
public class UserEntity {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(name = "user_id", nullable = false, unique = true, length = 10)
    private String userId;
    @Column(nullable = false, length = 20)
    private String name;
    @Column(nullable = false, length = 150)
    private String pw;

    @Column(nullable = false, length = 10)
    private String address1;
    @Column(nullable = false, length = 50)
    private String address2;
    @Column(nullable = false, length = 50)
    private String address3;

    @Column(nullable = false, length = 20)
    private String tel;

    @CreationTimestamp
    private LocalDateTime createdAt = LocalDateTime.now();

    @Builder
    public UserEntity(@NonNull Long id, @NonNull String userId, @NonNull String name, @NonNull String pw, @NonNull String address1, @NonNull String address2, @NonNull String address3, @NonNull String tel) {
        this.id = id;
        this.userId = userId;
        this.name = name;
        this.pw = pw;
        this.address1 = address1;
        this.address2 = address2;
        this.address3 = address3;
        this.tel = tel;
    }
}

UserEntity를 다음과 같이 정의했다.

@AllArgsConstructor
@Getter
public class RequestUser {
    private String userId;
    private String pw;
    private String name;
    private String address1;    //우편번호
    private String address2;    //도로명 주소
    private String address3;    //상세 주소
    private String tel;         //전화번호
}

RequestUser라는 Vo를 정의하여 Controller에서 매개변수로 받을거고


@SpringBootApplication
@EnableDiscoveryClient
public class LoginServiceApplication {

	public static void main(String[] args) {
		SpringApplication.run(LoginServiceApplication.class, args);
	}

	//비밀번호 암호화용 encoder
	@Bean
	public BCryptPasswordEncoder passwordEncoder(){
		return new BCryptPasswordEncoder();
	}
}

비밀번호 암호화를 위해 Security에서 제공하는 Encoder를 Bean으로 등록해준다.

@Getter
@AllArgsConstructor
@Builder
public class ResponseUser {
    String userId;
}

Vo ResponseUser를 추가하고

public interface UserService {
    ResponseUser join(RequestUser user);
}

service interface를 추가해준다.

ModelMapper와 같은 자동 매퍼 라이브러리들이 있지만 성능에 저하나 설정에 있어서 시간이 오래 걸리기 때문에 원래 사용하던 builder 패턴으로 생성한다.

@Repository
public interface UserRepository extends CrudRepository<UserEntity, Long> {
}

repository는 다음과 같이 생성하고

@Service
@RequiredArgsConstructor
public class UserServiceImpl implements UserService{
    private final BCryptPasswordEncoder passwordEncoder;
    private final UserRepository userRepository;

    @Override
    public ResponseUser join(RequestUser user) {
        UserEntity userEntity = UserEntity.builder()
                .userId(user.getUserId())
                .pw(passwordEncoder.encode(user.getPw()))
                .name(user.getName())
                .address1(user.getAddress1())
                .address2(user.getAddress2())
                .address3(user.getAddress3())
                .tel(user.getTel())
                .build();

        UserEntity save = userRepository.save(userEntity);

        return ResponseUser.builder().userId(save.getUserId()).build();
    }
}

UserServiceImpl의 회원가입 로직을 다음과 같이 작성했다.

이제 포스트맨을 통해 요청해보자.

다음과 같이 요청했고

데이터도 잘 들어왔다.

하지만 에러가 발생했는데... 이유는 pw의 길이를 너무 짧게 잡아놨다. 암호화 이후에 길이가 60까지 길어져버려서 오류가 났다. 길이를 150까지 늘려버리자.

정상적으로 잘 등록되었다!

DB에도 정상 등록된 것을 확인할 수 있었다.

👉api처럼 반환해보기

정상 실행은 되지만 api처럼 뭔가 형식이 없이 그냥 내가 반환하고 싶은대로 반환이 된다. api라면 일정한 규칙이 있는 스펙을 정의해두고 해당 스펙으로 반환해주는 것이 사용자에게도 좋기 때문이다.

@Getter
public class CommonResponse<T>{
    private String code;
    private String msg;
    private T data;

    @Builder
    public CommonResponse(String code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
}

CommonResponse class를 정의해서 사용해보자.

@RestController
@RequiredArgsConstructor
@RequestMapping(value = "/")
@Slf4j
public class UserController {

    private final UserService userService;

    @PostMapping("/join")
    public ResponseEntity<CommonResponse<Object>> join(@RequestBody RequestUser user){
        log.debug("user = {}", user.toString());
        ResponseUser responseUser = userService.join(user);
        CommonResponse<Object> response = CommonResponse.builder()
                .code("200")    //api 정의된 코드
                .msg("회원가입 정상실행")    //api 정의된 메세지
                .data(responseUser) //데이터
                .build();
        return ResponseEntity.status(HttpStatus.CREATED).body(response);
    }
}

UserController를 다음과 같이 수정해줬다.

이제 다시 실행해보고 결과값을 확인해보자!

결과 값은 다음과 같이 나오는데 이제 은근 api 같이 반환한다. Exception 처리도 해줘야하는데. 우선 jwt도 적용해야하니 다 해놓고 해보자!

최준호

코딩을 깔끔하게 하고 싶어하는 초보 개발자 (편하게 글을 쓰기위해 반말체를 사용하고 있습니다! 양해 부탁드려요!) 현재 KakaoVX 근무중입니다!