Eco 의 개발일기

MockTest 간단 사용법 (RestDocs 를 위한)

Eco — Tue, 28 Jun 2022 01:36:19 +0900

<피드백 언제나 환영합니다! 댓글 감사합니다>

Spring swagger 3.0.0 설정 에서 사용한 repository를 그대로 따라갈 예정 입니다. 기본적인 RestDocs 사용법 이 끝난 이후는 Test 부분을 다뤄 볼 예정 입니다.

Mock 이란?

실제 객체를 만들어 사용하기에 시간, 비용등이 높거나 객체 서로간의 의존성이 강해 힘들경우 가짜 객체를 만들어 사용하는 방법

실제 Spring Web 을 이용한 Controller 부분 이나 Service 부분이 이해 해당됩니다 조금더 구체적으로 말하면 네트워크 데이터베이스등, 단위 테스트가 어려울때 즉, 시스템의 다른 부분에 많이 얽혀 있고 의존해 있다면 ~~고려해볼만 합니다.~~ 사용해야 합니다.

라이브러리 추가

//build.gradle
dependencies {
	  ....
    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
		....
}

Mock을 통해 유닛 테스트하기

테스트를 하기전 기존의 코드에 간단하게 추가해야할 부분이 있어 추가 할 예정 입니다.

TestController.java

....
@RestController
public class TestController {

    @Autowired
    private TestUserService userService;

    @PostMapping(value = "/user")
    public UserDto helloUser(@RequestBody UserDto userDto){
        return userService.createUserDto(userDto);
    }

		@GetMapping(value = "/userInformation/{id}")
    public UserDto userInformation(@PathVariable Integer id){
        return userService.findUserDto(id);
    }
	....
}

UserDto 를 이용하여 User 를 등록하는 Controller를 추가 해 줍니다. → Controller 를 통하여 등록 과 조회를 두부분을 나누어 이야기 해볼 생각입니다.

TestUserService.java

@Service
public class TestUserService {
    private static final Map<Integer, UserDto> USER_DTO_MAP = new HashMap<>();

    public UserDto createUserDto(UserDto userDto) {
        if(USER_DTO_MAP.containsKey(userDto.getId())){
            throw new IllegalArgumentException("중복 Id");
        }
        USER_DTO_MAP.put(userDto.getId(), userDto);
        return userDto;
    }

    public UserDto findUserDto(Integer id) {
        return USER_DTO_MAP.get(id);
    }
}

DB 연동의 경우 설정 부분이 많아 간소화 하여, Map 형태로 관리하는 형식으로 지정 해둡니다.

위의 두 코드가 추가가 되었다면 test 모듈에서 TestController 에 대한 Test 를 만들어 줍니다.

TestControllerTest.java

//@SpringBootTest
@WebMvcTest(TestController.class)
@AutoConfigureRestDocs
class TestControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Autowired
    private ObjectMapper objectMapper;

    @MockBean
    private TestUserService userService;

    private UserDto getUserDto(String hello_MockTest) {
        UserDto userDto = new UserDto();
        userDto.setStatus(true);
        userDto.setId(1);
        userDto.setCreateAt(LocalDateTime.now());
        userDto.setName(hello_MockTest);
        return userDto;
    }

    @Test
    public void mockMvcTestCreate() throws Exception {
        UserDto userDto = getUserDto("MockTest");

        given(userService.createUserDto(userDto)).willReturn(userDto);

        String content = objectMapper.writeValueAsString(userDto);

        ResultActions perform = mockMvc.perform(post("/user")
                .content(content)
                .contentType(MediaType.APPLICATION_JSON)
                .accept(MediaType.APPLICATION_JSON));

        perform.andExpect(status().isOk())
                .andExpect(jsonPath("$.id").exists())
                .andExpect(jsonPath("$.name").value(userDto.getName()))
                .andDo(print());
    }

    @Test
    public void mockMvcTestFind() throws Exception {
        UserDto userDto = getUserDto("MockTest");

        given(userService.createUserDto(userDto)).willReturn(userDto);
        when(userService.findUserDto(userDto.getId())).thenReturn(userDto);

        ResultActions perform = mockMvc.perform(get("/userInformation/{id}", 1)
                .contentType(MediaType.APPLICATION_JSON)
                .accept(MediaType.APPLICATION_JSON));

        perform.andExpect(status().isOk())
                .andExpect(jsonPath("$.id").exists())
                .andExpect(jsonPath("$.name").value(userDto.getName()))
                .andDo(print());
    }

//@SpringBootTest → MockTest를 할때 Spring 을 사용해야해서 켜놓을거라 생각하지만 실제 IllegalStateException: Configuration error:found multiple declarations of @BootstrapWith 에러를 발생 시킵니다.

@WebMvcTest(TestController.class) → MockTest 시 반드시 써야 하는 부분이며 해당 Controller 또는 Service를 적어 사용 하면 됩니다. @SpringBootTest 와 함께 쓰면 안되는데 이유는 이 어노테이션 안에도 @BootstrapWith 가 내장되어 있어 중복 설정 오류를 발생 시킵니다.

@AutoConfigureRestDocs → 후 Rest docs 로 Swagger와 연계하기위해 만들어둔 어노테이션 입니다. (후에 RestDocs 에 다루겠습니다.)

Controller 에서 새로 추가된 두 method 만 테스트를 진행 하였으며 간략히 살펴보겠습니다.

(MockTest 의 경우 static으로 추가된 부분이 많습니다. 어떤 부분을 사용하였는지 적어 놓을 예정입니다.)

@Test
    public void mockMvcTestCreate() throws Exception {
        UserDto userDto = getUserDto("MockTest");

        given(userService.createUserDto(userDto)).willReturn(userDto);

        String content = objectMapper.writeValueAsString(userDto);

        ResultActions perform = mockMvc.perform(post("/user")
                .content(content)
                .contentType(MediaType.APPLICATION_JSON)
                .accept(MediaType.APPLICATION_JSON));

        perform.andExpect(status().isOk())
                .andExpect(jsonPath("$.id").exists())
                .andExpect(jsonPath("$.name").value(userDto.getName()))
                .andDo(print());
    }

given() → import static org.mockito.BDDMockito.given;
- mock 에서 가로채 실제 url 이 호출될때 작업해야하는걸 잡아 둡니다.
- mock 객체의 동작을 미리 정의 하여 리턴되는 값을 미리 생성 합니다

perform() → Rest 를 정의하고 들어가는 url을 정의합니다.

post() → org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; → MockMvcRequestBuilders 로 간단히 표시
- Rest 중 post 로 정의하고 url 을 정의합니다.

status() → MockMvcRequestBuilders
- HTTP의 상태 코드 값을 정의 합니다.

jsonPath() → MockMvcRequestBuilders
- 결과 값이 json 형태로 왔을시 $ 를 이용하여 json 값을 표현할 수 있습니다.
- $.{…} → {…} depthLevel 을 뜻하며 json 값들을 호출하여 불러올 수 있습니다.

@Test
    public void mockMvcTestFind() throws Exception {
        UserDto userDto = getUserDto("MockTest");

        given(userService.createUserDto(userDto)).willReturn(userDto);
        when(userService.findUserDto(userDto.getId())).thenReturn(userDto);

        ResultActions perform = mockMvc.perform(get("/userInformation/{id}", 1)
                .contentType(MediaType.APPLICATION_JSON)
                .accept(MediaType.APPLICATION_JSON));

        perform.andExpect(status().isOk())
                .andExpect(jsonPath("$.id").exists())
                .andExpect(jsonPath("$.name").value(userDto.getName()))
                .andDo(print());
    }

when() → MockMvcRequestBuilders
- mock 에서 when 안에 동작을 할때 return 으로 어떤 값을 내보내는지 정의 하기 위함입니다.
- 실제 mock 에서 url 이 호출 될때 when 동작을 통해 값을 확인할때 사용 합니다.

get() → MockMvcRequestBuilders
- Rest 중 get으로 정의하고 url 을 정의합니다.

github 코드 : https://github.com/Eco-Min/Swagger

Uploaded by Notion2Tistory v1.1.0

Spring swagger 3.0.0 설정

Eco — Wed, 22 Jun 2022 01:52:15 +0900

<피드백 언제나 환영합니다! 댓글 감사합니다>

swagger는 RestFul APi → OpenAPI 스펙을 기준으로 문서화 해서 HTML 페이지로 바꿔주는 역활을 합니다.

저는 3.0.0 을 기준으로 작성하였으며 2.X.X 의 경우 조금 다릅니다. 아래 springfox 문서를 통해서 작성했으며 간단하게 알아보도록 하겠습니다.

Springfox Reference Documentation

https://springfox.github.io/springfox/docs/current/

Spring 설정

spring 2.7.0

java 17

dependency : Spring Web, Lombok

dependency 는 하나씩 추가하면서 해보도록 하겠습니다.

라이브러리 추가

....
dependencies {
    ....
	  // https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui
    implementation 'io.springfox:springfox-swagger-ui:3.0.0'
    // https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter
    implementation 'io.springfox:springfox-boot-starter:3.0.0'
}
....

3.0.0 버전을 사용했으며 UI 및 기타 설정시 2.X.X 버전과 다를수 있습니다.

* Swagger 버전에 따른 UI URL 체크* 
2.X.X  :  http://localhost:8080/swagger-ui.html
3.X.X  :  http://localhost:8080/swagger-ui/index.html

간단한 코드 작성

SwaggerConfig.java

package com.example.swagger_restdocs.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    private final static String API_NAME = "Swagger_Study API";
    private final static String API_VERSION = "0.0.1";
    private final static String API_DESCRIPTION = "Swagger_Study API 명세서";

    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build().apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(API_NAME)
                .description(API_DESCRIPTION)
                .version(API_VERSION)
                .build();
    }
}

@EnableSwagger2 → Swagger2 활성화

new Docket(DocumentationType.SWAGGER_2).select() → API 에 사용되는 builder 생성 입니다.

apis() → RequestHandlerSelectors 를 이용 api 스펙이 작성되는 즉, Controller 부 basepackage를 지정 합니다.

paths() → PathSelectors를 이용 apis() 에 선택된 스팩들중 특정 path 조건을 다시 필터링 합니다.

ApiInfo → Swagger에 사용되는 title, description, version 등이 사용이됩니다.

위 관련 설정은 가장 기본적인 설정이며 지금은 저런 설정이 있다 정도만 알아둘 예정입니다. (나중에 조금더 심층적으로 파보겠습니다.)

⨳위 설정후 Swagger UI를 통해 기본적인 UI를 확인할수 있습니다. 하지만 3.0.0 부터는 빌드시 Err 가 발생합니다.

org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; 
nested exception is java.lang.NullPointerException: Cannot invoke 
"org.springframework.web.servlet.mvc.condition.PatternsRequestCondition.getPatterns()" because "this.condition" is null
// 위 같이 Err 발생시 application.yml 파일에 설정을 해야할게 하나 있습니다.

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

TestController.java

package com.example.swagger_restdocs.controller;

import io.swagger.annotations.*;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalDateTime;
import java.util.HashMap;
import java.util.Map;

@RestController
public class TestController {

    @ApiOperation(value = "user", notes = "user 정보")
    @GetMapping(value = "/user")
    public UserDto helloUser(){
        UserDto userDto = new UserDto();
        userDto.setId(5);
        userDto.setName("hello");
        userDto.setStatus(true);
        userDto.setCreateAt(LocalDateTime.now());
        return userDto;
    }

    @ApiOperation(value = "paramSample", notes = "테스트입니다")
    @ApiResponses({
            @ApiResponse(code = 200, message = "ok"),
            @ApiResponse(code = 404, message = "페이지 못찾음")
    })
    @GetMapping(value = "/paramSample")
    public Map<String, String> selectBoard(@ApiParam(value = "샘플번호", required = true, example = "1")
                                           @RequestParam String no) {

        Map<String, String> result = new HashMap<>();
        result.put(no, "테스트");
        result.put("test contents", "테스트 내용");
        return  result;
    }
}

UserDto.java

package com.example.swagger_restdocs.controller;

import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.time.LocalDateTime;

@Data
public class UserDto {
    @ApiModelProperty(example = "유저 아이디")
    private Integer id;
    @ApiModelProperty(example = "유저 이름")
    private String name;
    private boolean status;
    private LocalDateTime createAt;
}

@ApiOperation → 어노테이션을 API에 추가해 API에 대한 주석을 달 수 있음(옵션)

@ApiResponses → response 상태 값에 따라 설명을 적어놓는 있다

@ApiParam → @RequestParam 시 필요한 부분을 테스트 할수 있도록 적어 놓은 부분

@ApiModelProperty → Dto 들의 값(JSON) 표현시 사용되는 일종의 값

Swagger UI

위 그림처럼 표현 되며 페이지에 Rest Api 가 문서화 되서 생성이 된다. 주요 할점은 2.X.X 랑 3.0.0의 URL 주소 방식이 다르기 때문에 꼭 비교하면서 써야한다.

github 코드 : https://github.com/Eco-Min/Swagger

Uploaded by Notion2Tistory v1.1.0

Notion 블로그 (Tistory 이전)

Eco — Tue, 14 Jun 2022 22:51:48 +0900

티스토리 쓰기전 Notion에 미리 공부하기위해 적어 놓은 것들이 있습니다. (notion 못버려...)

혹시나 도움이 될까봐 올려 놓겠습니다.

<피드백 언제나 환연합니다 -> Notion은 댓글 기능이 없으므로 여기에 피드백 부탁 드립뉘당...>

Eco_Min 블로그

티스토리 블로그 : https://gangda.tistory.com → 많이 와주세요..

https://just-musician-4e4.notion.site/0d03987b0bae4d418378b134b3fa4db1?v=ecbbcbb2362e4e8abdfd160e2e86f9c7

Uploaded by Notion2Tistory v1.1.0

MS_SQL 에서 쿼리가 너무 늦게 나가요…

Eco — Sat, 4 Jun 2022 23:50:37 +0900

<피드백 언제나 환영합니다! 댓글 감사합니다>

쿼리에 인덱싱을 걸어서 사용하였음에도 불구하고 DB 속도가 너무 늦게 나오네요 분명 DB tool 에서 조회시에는 느리지 않았는데..

그래서 검색 해본결과 MS_SQL 은 성능을 추적 할 수 있는 도구가 있어서 실행 해보았습니다.

Profileing 하는 법은 아래 두 블로그를 보고 확인 하였습니다.

[MS_SQL] 프로파일러 사용법 (tistory.com)

[MSSQL] 프로파일러(Profiler) 실행 & 쿼리 추적 사용법 (tistory.com)

확인 해보니 varchar 로 지정 하던 것이 nvarchar로 나가게 되면서 인덱싱 또한 깨지게 됩니다. 관련 검색중 우아한 형제 블로그 에서 저와 비슷한 증상이 있어 적용해 보니 해결이 되었습니다.

SQL Server 에게 String 이란? (NVARCHAR 인가 VARCHAR 인가) | 우아한형제들 기술블로그

SQL Server JDBC Driver 를 사용하면서 배운, 그리고 주의해야 할 특징 안녕하세요. 비즈상품개발팀에서 광고시스템을 개발하고 있는 김승영입니다. 현재 광고시스템의 일부분이 Spring Boot / JPA 기반에 SQL Server JDBC Driver 를 사용해서 운영하고 있는데요. 그 SQL Server JDBC Driver 를 사용하면서 배운, 주의해야 할 1가지 특징을 공유하고자 합니다.

https://techblog.woowahan.com/2605/

그래서 간단히 적용 하는 방법과 왜 그런 문제가 있는지 간단하게 알아 보겠습니다.

문제점

SQL Server JDBC Driver 의 String 파라미터들은 nvarchar 로 매핑합니다 심지어 PreparedStatement.set 호출시 varcar 로 매핑하여도 nvarchar로 매핑 되는 문제

MS 공식 문서에 따르면 데이터 형식 우선순위 위가 있었습니다. 그래서 묵시적 변환이 일어나는 현상이 일어납니다.

해결 방법

가장 간단한 해결방법은 JDBC URL 에 sendStringParametersAsUnicode=false 를 추가하는 방법 입니다.

spring:
  datasource:
    driverClassName: com.microsoft.sqlserver.jdbc.SQLServerDriver
		# 아래 sendStringParametersAsUnicode=false 추가
    url: jdbc:sqlserver://localhost:1433;database=데이터베이스;sendStringParametersAsUnicode=false

이 설정 후 모든 String을 varchar로 매핑이 됩니다.

만약 반대로 Index 가 nvarchar 로 되어 있고 url 에 sendStringParametersAsUnicode=false 를 적으면 어떻게 될까요? → 우선순위에 따라 조건으로 들어온 Paramater가 형변환이 일어나는거라 Index에 영향이 없습니다. → (varchar → nvarchar) 로 되는 형변환이 문제 이기 때문에 Index유지 되고 성틍에 큰 문제가 안됩니다.

그래도 나는 sendStringParametersAsUnicode=false 설정 후 nvarchar를 꼭 지정해서 사용하고 싶어 하는 경우

JPA / Hibernate / JPQL
매핑하는 컬럼 필드에 @Nationalized 를 사용 하면 됩니다.
```
@Nationalized
@Colum(name ="Member_name")
private String memberName;
```

jdbcTemplate

String sql = "select * from Member where member_name = ?"
Connection con = DataSourceUtils.getConnection(dataSource);;
psmt = con.prepareStatement(sql);           
psmt.setString(1, memberName);

JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
        jdbcTemplate.query("select * from Member where member_name = ?",
                ps -> {
                    ps.setNString(1, "Min");
                },
                rs -> {
                    log.info(rs.getString("memberName"));
                });

Uploaded by Notion2Tistory v1.1.0

Spring ServerSentEvent (작성중...)

Eco — Tue, 12 Apr 2022 01:06:17 +0900

작성중입니다. → 완전히 다적힐때까지 조금만 기다려주세요...

<피드백 언제나 환영합니다! 댓글 감사합니다>

알림을 보내줘야할때 또는 실시간으로 데이터를 보내줘야 할 경우가 있습니다. 그때 사용하는 기술중 하나인 SSE(Server Sent Event)를 알아볼 예정입니다.

실시간 웹앱 개발시 사용되는 방법

실제 실시간 통신에서 사용되는 기술들이 있습니다. 그중 3가지를 뽑아 간단하게 알아 보겠습니다.

Polling(client pull)
클라이언트가 일정한 주기로 서버에 업데이트 요청을 보내는 방법, 지속적인 HTTP 요청발생 → 리소스 낭비 발생

WebSocket(server push)
실시간 양방향 통신을 위한 스펙, 서버와 브라우저가 지속적으로 연결된 TCP 라인을 통해 실시간으로 데이터를 주고받는 HTML5 사양 → 연결지향 양방향 전이중 통신이 가능 (채팅, 게임 주식, 차트등에 사용된다) → 서버 클라이언트간 양방향 통신

Server Sent Event(SSE)
이벤트가 (서버 → 클라이언트) 방향으로만 흐르는 단방향 통신 채널 http 요청을 보낼 필요 없이 http 연결을 통해 서버에서 클라이언트로 데이터를 보낼 수 있다.

Server Sent Event(SSE)

HTTP 스트리밍을 통해 서버에서 클라이언트로 단방향의 Push Notification을 전송할 수 있는 HTML5 표준 기술

EventStream 최대 개수는 HTTP/1.1 6개, HTTP/2 사용시 최대 100개까지 유지 가능 합니다.

Javascript의 EventSource를 이용하여 사용 가능 → 접속에 문제가 있으면 자동으로 연결을 재시도 하는 특징이 있습니다.

IE 에서 polyfill을 통해 사용가능 → 이제는 보내줍시다...

Server To Client 단반향 연결 지원 → 서버에서 데이터를 프론트로 일방적으로 내려주는 케이스에서 적절

Spring 에서 SSE를 적용 해보자

적용전 해줘야 할는게 있는데 바로 Postman 과 VsCode 를 설치 해야 합니다 → Data 전송 과 화면 표시를 위해

VsCode Extension LiveServer 설치 → html 파일을 바로 로드하여 확인하기 위해

PostMan → 서버 Event 발생 도구

Spring → web, lombock, devtool (dependecy 설정)

요구 사항

화면
- 데이터를 화면에서 실시간으로 표시
- [ Title ] --> [ Text ]

서버 컨트롤러
- Cros / GetMapping → SseEmitter 를 이용 (서버 → 클라이언트) 단방향 통신 대기
- Cros / PostMapping(ToALL) → 연결 되어 있는

먼저 코드를 적어놓고 하나씩 분석해 가면서 설명 하겠습니다.

VsCode - sseIndex.html

VsCode 에 임의로 html 파일을 만들어 표시되는걸 보기위한것 → 간단히 작성할 예정

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
    <title>Document</title>
</head>

<body>
    <input id="userId" disabled="false">
    <ol id="list">

    </ol>
    <script>
        $(document).ready(function () {

            let userId = Math.floor((Math.random() * 1000) + 1);
            document.getElementById("userId").value = userId; // LiveServer 에서 사용하는 userId
            let urlENdPoint = 'http://localhost:8080/subscribe?userId=' + userId;
            let eventSource = new EventSource(urlENdPoint); // javascript SSE 받아서 사용하는 부분

            eventSource.addEventListener("latestNews", function (event) {
                console.log("urlEndPoint : " + urlENdPoint)
                console.log("EVENT : " + event);
                console.log("EVENT : " + event.data);
                let artilceSource = JSON.parse(event.data);
                console.log("artilceSource : "+ artilceSource)

                $("#list").append("<li>" + artilceSource.Title +" --> "+ artilceSource.Text + "</li>");
            });

        })
    </script>

</body>

</html>

NewsController.java

package com.example.RealTimeNews.controller; // package 위치 -> Controller 형태로 받을 예정

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.mvc.method.annotation.SseEmitter;

import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;

@RestController
@Slf4j
public class NewsController {

    public List<SseEmitter> emitters = new CopyOnWriteArrayList<>();
    public Map<String, SseEmitter> mapEmitters = new ConcurrentHashMap<>();
    // method for client subscription
    @CrossOrigin
    @GetMapping(value = "/subscribe", consumes = MediaType.ALL_VALUE)
    public SseEmitter subscribe(@RequestParam String userId) {
        SseEmitter sseEmitter = new SseEmitter(Long.MAX_VALUE);
        sendInitEvent(sseEmitter);

        logFormListEmitters(sseEmitter);
        logFormMapEmitters(userId, sseEmitter);

        return sseEmitter;
    }

    // method for dispatching events to all clients
    @CrossOrigin
    @PostMapping(value = "/dispatchEventToAll")
    public void dispatchEventToClients(@RequestParam String title, @RequestParam String text){
        Map<String, String> mapForJson = Map.of("Title", title, "Text", text);
        for (SseEmitter emitter : emitters) {
            try {
                emitter.send(SseEmitter.event().name("latestNews").data(mapForJson));
                log.info("PostMapping for all clients SSE Emitters : {}", emitters);
            } catch (IOException e) {
                emitters.remove(emitter);
                log.info("Exception SSE Emitters : {}", emitters);
            }
        }
    }

    // method for dispatching events to specific clients
    @CrossOrigin
    @PostMapping(value = "/dispatchEventToSpecific")
    public void dispatchEventToSpecificClients(@RequestParam String title, @RequestParam String text, @RequestParam String userId){
        Map<String, String> mapForJson = Map.of("Title", title, "Text", text);
        SseEmitter sseEmitter = mapEmitters.get(userId);
        if (sseEmitter != null) {
            try {
                sseEmitter.send(SseEmitter.event().name("latestNews").data(mapForJson));
                log.info("PostMapping for specific clients SSE Emitters : {}", mapEmitters);
            } catch (IOException e) {
//                emitters.remove(sseEmitter);
                mapEmitters.remove(userId);
                log.info("Exception SSE Emitters : {}", mapEmitters);
            }
        }
    }

    private void sendInitEvent(SseEmitter sseEmitter) {
        try {
            sseEmitter.send(SseEmitter.event().name("INIT"));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    private void logFormListEmitters(SseEmitter sseEmitter) {
        log.info("------------------All Clients-----------------");
        log.info("first SSE Emitters : {}", emitters);

        sseEmitter.onCompletion(() -> emitters.remove(sseEmitter));
        log.info("onCompletion remove SSE Emitters : {}", emitters);

        emitters.add(sseEmitter);
        log.info("after add SSE Emitters : {}", emitters);
    }

    private void logFormMapEmitters(String userId, SseEmitter sseEmitter) {
        log.info("------------------SpecificClients-----------------");
        log.info("first SSE Emitters : {}", mapEmitters);
        mapEmitters.put(userId, sseEmitter);
        log.info("map SSE Emitters : {}", mapEmitters);


        sseEmitter.onCompletion(() -> mapEmitters.remove(userId));
        log.info("onCompletion remove SSE Emitters : {}", mapEmitters);

        sseEmitter.onTimeout(() -> mapEmitters.remove(userId));
        log.info("onTimeout remove SSE Emitters : {}", mapEmitters);

        sseEmitter.onError((e) -> mapEmitters.remove(userId));
        log.info("onError remove SSE Emitters : {}", mapEmitters);
    }
}

PostMan 데이터
http://localhost:8080/dispatchEventToAll?title=Corona is ending&text=I am Happy
- Params / key : title | value : Corona is ending
- Params / key : text | value : I am Happy
http://localhost:8080/dispatchEventToSpecific?title=only this id sent&text=hello!!!&userId=853
- Params / key : title | value : only this id sent
- Params / key : text | value : hello!!!
- Params / key : userId | value : 853 (VsCode 에 있는 userId)

참조

https://sg-choi.tistory.com/542

https://velog.io/@max9106/Spring-SSE-Server-Sent-Events를-이용한-실시간-알림

Uploaded by Notion2Tistory v1.1.0

LogBack - 설정(.xml)

Eco — Mon, 7 Mar 2022 23:22:01 +0900

<피드백 언제나 환영합니다! 댓글 감사합니다>

Apache Tomcat 운영중 stdout, stderr 같은 log의 경우 날짜별로 쌓이는게 아닌 한 log 파일에 쌓이게 된다.

이런부분 때문에 apache tomcat의 log를 막고 logback 이용하여 log를 관리할 예정이다.

들어가기전...

들어가기전 Profile.active 를 이용 다른 application.properties or application.yml 을 먼저 설정 해야 한다.

→ 무조건 필요한게 아니지만 logback 시작때 다시한번 언급 할 예정입니다. 아래 링크를 확인하여 설정을 할 수 있습니다.

Profile.active 를 이용 다른 설정 정보 (작성중..)

우리는 properteis 또는 yml 을 통해 spring의 설정을 합니다. 실무에서의 개발에서는 application은 다양한 환경에서 일어납니다. dev → application-dev → 개발..

https://gangda.tistory.com/25

application.proerteis 또는 .yml 파일에서도 설정을 할 수 있지만 세부적인 설정까지는 어렵습니다. 그래서

logback.properteis, logbakc-spring.xml 로 나누어 설정을과 예제를 보여드릴 예정 입니다.

Log를 왜 쓸까요??

너무 간단한 이야기 입니다. Log를 통해 우리는 개발과정 혹은 운영 과정에서 예상치 못한 어플리케이션의 문제를 진단 및 사용자 로그를 이용 분석하여 조금더 사용자에게 친화적인 환경을 구성할수 있습니다. 하지만 로깅을 하는 단계에서 로그 기준을 잡지 못하면 방대한양의 로그파일이 쌓여 의미있는 로그가 쌓이지 않습니다.

결국 효율적으로 로깅하는 방법이 중요합니다 → 실무마다 적용이 달라 우리는 사용하는 방법 위주로 공부 할 예정입니다.!!

스프링에서는 어떻게 사용 할까요??

Log4j와 LogBack으로 스프링 부트의 로그구현체를 사용 합니다. Logback 은 log4j 이후에 출시된 Java 기반 Logging Framework 중 하나로 가장 널리 사용되고 있습니다. SLF4j 의 구현체이며 Spring Boot 환경이라면 별도의 dependency 추가 없이 기본적으로 포함되어 있습니다. logback.properteis, logbakc-spring.xml 을 이용 log를 이용하여 관리할 예정입니다.

즉, logback은 Java / Spring 에 조금 친화적이며 후 Log4J를 이용 Log 관리를 알아보도록 하겠습니다.

Log4J 보안 이슈

Log4J(Log4Shell) 역대급 보안 취약점 정리(22.01.24 업데이트)

역대급 핫 이슈였던 `Log4J(Log4Shell) 역대 최악 보안 취약점( CVE-2021-44228)` 외 8개까지 정리해봅니다.(`22.01.24 업데이트). 한번 터지더니 최근 계속해서 이슈가 되고 있는 것 같습니다. 아예 log4j 취약점을 찾는 사람들이 계속해서 파고 있는 느낌? 나름 IT 밥을 먹고 있는 사람으로 정리를 하지 않고 넘어가면 안될것 같아서 남들이 정리한걸 다시 재정리하는 느낌으로 정리해봅니다.

https://nhj12311.tistory.com/575

간단한 Log 표시 사용법

1. LoggerFactory 를 이용한 생성

package com.log.findlog.log1;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class log1Controller {

    private static final Logger log = LoggerFactory.getLogger(log1Controller.class);

    @GetMapping("/log1")
    public String log1() {
        log.info("hello log1");
        return "ok";
    }
}

2. lombok @Slf4j 을 이용한 방법

package com.log.findlog.log2;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
public class log2Controller {

    @GetMapping("/log2")
    public String log1() {
        log.info("hello log2");
        return "ok";
    }
}

로그 레벨 관련

Logback 은 5단계의 로그 레벨을 가진다.심각도 수준은 Error > Warn > Info > Debug > Trace 이다.

⛔️ Error : 예상하지 못한 심각한 문제가 발생하는 경우, 즉시 조취를 취해야 할 수준의 레벨

⚠ ️Warn : 로직 상 유효성 확인, 예상 가능한 문제로 인한 예외 처리, 당장 서비스 운영에는 영향이 없지만 주의해야 할 부분

✅ Info : 운영에 참고할만한 사항, 중요한 비즈니스 프로세스가 완료됨

⚙️ Debug : 개발 단계에서 사용하며, SQL 로깅을 할 수 있음

Trace : 모든 레벨에 대한 로깅이 추적되므로 개발 단계에서 사용함

✨로그파일 작성하기

먼저 로그 관련하여 전반적인 코드를 먼저 작성하고 하나하나 뜯어보면서 하겠습니다.

resources 폴더에 저장하면 됩니다.

application.properties
```
spring.profiles.active=dev
```

application-dev.properties
```
server.port=9090
```

logback-dev.properties

log.config.path=D:\\logs
log.config.normal.filename=normal
log.config.error.filename=error

logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration> 
	<!-- springProfile -->
	<springProfile name="dev">
		<property resource="logback-dev.properties" />
	</springProfile>
	
	<!-- log file path -->
	<property name="LOG_PATH" value="${log.config.path}" />
	
	<!-- log file name -->
	<property name="NOR_LOG_FILE_NAME" value="${log.config.normal.filename}" />
	
	<!-- err log file name -->
	<property name="ERR_LOG_FILE_NAME" value="${log.config.error.filename}" />
	
	<!-- pattern -->
	<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
	<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
	<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
	<property name="LOG_PATTERN" value="%clr(%d{yy-MM-dd E HH:mm:ss.SSS}){magenta} %clr(%-5p) %clr(${PID}){yellow} %clr(---){faint} %clr([%15.15t]){cyan} %clr(%-45.45c){faint} %clr(::){red} %clr(%m){green}%n" />
	<property name="FILE_LOG_PATTERN" value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

	<!-- Console Appender -->
	<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
			<pattern>${LOG_PATTERN}</pattern>
		</encoder>
	</appender> 
	
	<!-- Nomal File Appender -->
	<appender name="NORMAL" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
		<!-- 파일경로 설정 -->
		<file>${LOG_PATH}/${NOR_LOG_FILE_NAME}.log</file> 
		
		<!-- 출력패턴 설정 -->
		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
			<pattern>${FILE_LOG_PATTERN}</pattern>
		</encoder> 
		
		<!-- Rolling 정책 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
			<!-- .gz,.zip 등을 넣으면 자동 일자별 로그파일 압축 -->
			<fileNamePattern>${LOG_PATH}/${NOR_LOG_FILE_NAME}.%d{yyyy-MM-dd}_%i.zip</fileNamePattern>
			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> 
				<!-- 파일당 최고 용량 kb, mb, gb -->
				<maxFileSize>5KB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy> 
			
			<!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거 -->
			<maxHistory>30</maxHistory>
		</rollingPolicy>
	</appender> 
	
	<!-- Error File Appender -->
	<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
			<level>error</level>
			<onMatch>ACCEPT</onMatch>
			<onMismatch>DENY</onMismatch>
		</filter>
		
		<file>${LOG_PATH}/${ERR_LOG_FILE_NAME}.log</file>
		
		<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
			<pattern>${FILE_LOG_PATTERN}</pattern>
		</encoder>
		
		<!-- Rolling 정책 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
			<!-- .gz,.zip 등을 넣으면 자동 일자별 로그파일 압축 -->
			<fileNamePattern>${LOG_PATH}/${ERR_LOG_FILE_NAME}.%d{yyyy-MM-dd}_%i.log</fileNamePattern>
			<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> 
				<!-- 파일당 최고 용량 kb, mb, gb -->
				<maxFileSize>10MB</maxFileSize>
			</timeBasedFileNamingAndTriggeringPolicy> 
			<!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거 -->
			<maxHistory>30</maxHistory>
		</rollingPolicy>
	</appender>
	
	<!-- root레벨 설정 -->
	<root level="INFO">
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="NORMAL" />
		<appender-ref ref="ERROR" />
	</root>
	
	<!-- 특정패키지 로깅레벨 설정 -->
	<logger name="com.log.findlog.log2" level="DEBUG" additivity="false">
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="NORMAL" />
		<appender-ref ref="ERROR" />
	</logger>
</configuration>

1. configuration 설정

configuration

<?xml version="1.0" encoding="UTF-8"?>
<configuration> 
	<!-- springProfile -->
	<springProfile name="dev">
		<property resource="logback-dev.properties" />
	</springProfile>
	....
	....
<configuration>

설정 정보들을 넣을 수 있다. 예로들어 application.properteis 에서 사용하는 profile 설정, properties resource를 사용하여 log 를 메시지화 하여 관리 할 수 있다.

2. path 설정 및 fileName 설정

path 설정 및 fileName

<!-- log file path -->
<property name="LOG_PATH" value="${log.config.path}" />
<!-- log file name -->
<property name="NOR_LOG_FILE_NAME" value="${log.config.normal.filename}" />	
<!-- err log file name -->
<property name="ERR_LOG_FILE_NAME" value="${log.config.error.filename}" />

logback-dev.properties 에서 설정한 메시지 들을 xml내에 사용가능한 proerty화(메시지화)되어 재사용이 가능하다.

3. pattern

pattern

<!-- pattern -->
<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
<property name="LOG_PATTERN" value="%clr(%d{yy-MM-dd E HH:mm:ss.SSS}){magenta} %clr(%-5p) %clr(${PID}){yellow} %clr(---){faint} %clr([%15.15t]){cyan} %clr(%-45.45c){faint} %clr(::){red} %clr(%m){green}%n" />
<property name="FILE_LOG_PATTERN" value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

로그를 적을시 패턴을 적어서 사용하기위해 이용 된다. 주로 콘솔의 log와 파일의 log 패턴을 분류해서 사용한다.

clr : console에 색을 입혀 잘 보기 위해

4. console appender

console appender

<!-- Console Appender -->
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
	<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
		<pattern>${LOG_PATTERN}</pattern>
	</encoder>
</appender>

idea 에서 작업시 로그를 출력하기 위한 appender 이며 pattern에서 정의한 LOG_PATTERN의 정보를 사용한다.

5. normal fileAppender 출력 패턴 설정, rolling 설정

fileAppender 출력 패턴 설정

<appender name="NORMAL" class="ch.qos.logback.core.rolling.RollingFileAppender"> 
	<!-- 파일경로 설정 -->
	<file>${LOG_PATH}/${NOR_LOG_FILE_NAME}.log</file> 
		
	<!-- 출력패턴 설정 -->
	<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
		<pattern>${FILE_LOG_PATTERN}</pattern>
	</encoder>
	<!-- Rolling 정책 -->
	.... 
</appender>

file appender 는 파일의 경로 출력패턴 rolling 설정들을 하는 곳입니다. 저같은 경우 normal과 error 파일들을 분류하여 설정 하였습니다. 파일의 경로와 log 파일에 찍히는 패턴을 설정 합니다. (2.path 설정, 3.pattern 에서 정의한 내요을 사용 합니다.)

rolling 설정

<!-- Rolling 정책 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> 
	<!-- .gz,.zip 등을 넣으면 자동 일자별 로그파일 압축 -->
	<fileNamePattern>${LOG_PATH}/${NOR_LOG_FILE_NAME}.%d{yyyy-MM-dd}_%i.log</fileNamePattern>
		<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"> 
		<!-- 파일당 최고 용량 kb, mb, gb -->
		<maxFileSize>5KB</maxFileSize>
		</timeBasedFileNamingAndTriggeringPolicy> 		
		<!-- 일자별 로그파일 최대 보관주기(~일), 해당 설정일 이상된 파일은 자동으로 제거 -->
	<maxHistory>30</maxHistory>
</rollingPolicy>

rolling 정책은 로그파일의 용량과 일정 용량을 넘어갈시 log파일의 이름을 새로 만들어저장 최대 보한 기한을 설정 하빈다.

fileNamePattern : logfile의 지정 size 를 넘길시 새로운 이름을 부여해 저장합니다. (zip, gz 로 만들경우 log 파일을 압축하여 저장 합니다. → .log 로 남는게 아닌 name에 부여되 이름의 log 파일을 압축합니다)

maxFileSize : logfile의 size를 지정 할 수있으며 size가 오버되면 fileNamePattern 에 의해 이름이 정의 된다

maxHistory : 로그파일의 최대 보관 주기(일) 로 되며 해당 설정일 이상이된 파일은 자동으로 제거 됩니다.

6. error fileAppender

error 와 관련된게 따로 분류한 이유는 error와 관련된 부분만 저장하기 위해서이다. normalfileAppdender 와 별 다를점이 없다 그래서 다른 점 만 확인하겠습니다.

error fileAppdender

<appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
	<filter class="ch.qos.logback.classic.filter.LevelFilter">
		<level>error</level>
		<onMatch>ACCEPT</onMatch>
		<onMismatch>DENY</onMismatch>
	</filter>
	....
</appender>

log level 중 error 만을 사용하기위해 입니다. level을 설정한후 onMatch onMismatch 설정으로 leve단위로 설정할 수 있습니다.

7. append-ref 설정

append-ref 설정

<!-- root레벨 설정 -->
<root level="INFO">
	<appender-ref ref="CONSOLE" />
	<appender-ref ref="NORMAL" />
	<appender-ref ref="ERROR" />
</root>
	
<!-- 특정패키지 로깅레벨 설정 -->
<logger name="com.log.findlog.log2" level="DEBUG" additivity="false">
	<appender-ref ref="CONSOLE" />
	<appender-ref ref="NORMAL" />
	<appender-ref ref="ERROR" />
</logger>
</configuration>

append-ref 에 들어갈 값은 append name들의 이름 입니다.

root 설정은 spring 의 전박적인 package의 log 설정과 level 설정 후 실행합니다.

logger 설정은 특정 pacakge에 관한 log 설정과 level 설정후 실행합니다.

console 또는 logfile 의 내용들을 실행하며 이전에 설정해놓은 appender 들을 실행하는 곳입니다.

마치며..

기본적인 사용법과 설정을 알아 보았습니다. 이걸로 apache에서 제공하는 log 보다는 이부분을 사용하여 log파일을 따로

관리하는게 이점이 크다고 생각 합니다. 여러 블로그들을 확인하여 본 결과 로그파일의 크기는 100MB 정도로 하고 180일을 주기로

log파일들을 관리를 한다고 합니다 (물론 이점이 무조건 맞다는 아닙니다) 다음 번에는 properties에서 설정 하는 법을 확인해보도록 하겠습니다.

감사합니다!!

참조

https://tecoble.techcourse.co.kr/post/2021-08-07-logback-tutorial/

[10분 테코톡] ☂️ 검프의 Logging(로깅) #1 - YouTube

[10분 테코톡] ☂️ 검프의 Logging(로깅) #2 - YouTube

Uploaded by Notion2Tistory v1.1.0

Profile.active 설정 정보 (작성중..)

Eco — Wed, 2 Mar 2022 23:27:15 +0900

<피드백 언제나 환영합니다! 댓글 감사합니다>

우리는 properteis 또는 yml 을 통해 spring의 설정을 합니다. 실무에서의 개발에서는 application은 다양한 환경에서 일어납니다.

dev → application-dev → 개발환경

test → application-test → 테스트 환경

prod → application-prod → 실서버 환경

profile에 들어가는 단어는 미리 정의되어 있는것이 아닙니다. 개발자 마음이지만 통상 위의 약어를 사용 합니다.

profile 을 한 곳에서

profile을 한곳에서 전부 정의하여 쓰는 방법이다. yml 에서만 사용 가능하다 → 추천하지 않는 방법이다.

application.yml

spring:
  profiles:
    active: dev # 여기서 profile 의 이름을 선택해서 사용 하면 됩니다.

---
  spring:
    profiles: dev
  server:
    port: 8080

---
  spring:
    profiles: prod
  server:
    port: 9090

위 코드를 실제 이름을 변경하여 실행 해보면 port 가 다른부분을 확인할 수 있다.

profile 을 나누어서

profile을 나누어서 사용하는 방법이다 → 가장 추천하는 방법이다.

properteis 와 yml 둘다 사용할 수 있으며 application-XXX 로 구분 가능하다.

properteis

application.properties

# 여기서 pforiles.actiavte 의 이름을 바꾸면 됩니다.
spring.profiles.active=dev

application-dev.properties

server.port=8090

application-prod.properties

server.port=9090

yml

application.yml

# 여기서 pforiles.actiavte 의 이름을 바꾸면 됩니다.
spring:
  profiles:
    active: dev

application-dev.yml

server:
  port: 8090

application-prod.yml

server:
  port: 9090

위 코드를 실행 시켜보면 port 가 다른 부분을 확인할 수 있다.

참조

https://lejewk.github.io/springboot-gradle-spring-profiles-active/

https://bepoz-study-diary.tistory.com/371

Uploaded by Notion2Tistory v1.1.0

Pattern

Eco — Tue, 15 Feb 2022 14:25:58 +0900

<피드백 언제나 환영합니다! 댓글 감사합니다>

java 에서 정규표현식을 사용하려면 반드시 알아야하는 Pattern, Matcher Class가 있습니다. (JDK 17 사용)

제가 사용해 보면서 꼭 필요한 기준으로 정리하려 합니다.

먼저, 사용하기에 앞서 정규식 표현방법을 알아야 합니다.

https://gngsn.tistory.com/51

https://gngsn.tistory.com/52

Pattern Class

정규 표현식에 대상 문자열을 검증하는 기능으로 일치 불일치로 true, false를 반환합니다.

주로 검증에 활용 됩니다.

Matcher Class

Pattern Class를 받아 대상 문자열과 패턴이 일치하는 부분을 찾거나 전체일치 여부등을 판별하기위해 사용됩니다.

활용

먼저 코드와 코드 결과를 본후 이어 설명하겠습니다

public class Main {

    public static void main(String[] args) {
        String operator = "[+*/-]";
        String number = "[0-9]+";
        String value = "123+456";

        Pattern operatorCompile = Pattern.compile(operator);
        Matcher operatorMatcher = operatorCompile.matcher(value);
        String[] split = operatorCompile.split(value);

        for (String s : split) {
            System.out.println("split = " + s);
        }

        boolean isValid = operatorMatcher.find();
        if (isValid) {
            System.out.println("operatorMatcher = " + operatorMatcher.group());
        }

        Matcher numberMatcher = Pattern.compile(number).matcher(value);
        while (numberMatcher.find()) {
            System.out.println("numberMatcher = " + numberMatcher.group());
        }

        List<String> oldNumberMatcherList = numberMatcher.results().map(MatchResult::group).toList();
        System.out.println("oldNumberMatcherList = " + oldNumberMatcherList);

        List<String> newNumberMatcherList = Pattern.compile(number).matcher(value)
                .results().map(MatchResult::group).toList();
        System.out.println("newNumberMatcherList = " + newNumberMatcherList);
    }
}

결과

split = 123
split = 456
operatorMatcher = +
numberMatcher = 123
numberMatcher = 456
oldNumberMatcherList = []
newNumberMatcherList = [123, 456]

Pattern compile(regex)String 값으로 들어온 정규식을 Pattern 객체로 바꿔주는 역활을 합니다.

Matcher matcher(value)들어온 value 값과 compile 에 설정한 정규식이 매칭되게 Matcher 객체를 만들어 줍니다.

String split(value) [Patter 파생]Pattern의 regx 값과 value를 비교하여 regx 값의 항목 중심으로 문자열을 자릅니다.

boolean find() [Matcher 파생]regx 값과 value 값에서 일치한 값이 있으면true 없으면false 를 반환합니다

String group [Matcher 파생]regx 값과 value 값에서 일치한 문자열을 반환 합니다.

Stream<> results() [Matcher 파생]Matcher 에서 나온 값들을 stream화 합니다.
.results().map(...) 처럼 stream화 하여 list 형태로 뽑아 사용 가능합니다.

String replaceAll(replacement)패턴과 일치하는 모든 문자열을 replacement 로 변경

확인해 봐야할 점

oldNumberMatcherList newNumberMatcherList 를 비교를 해보자

oldNumberMatcherList 의 경우 numberMatcher 에서 find() → group() 을하여 값을 사용결과 에서 보듯 값이 list에 안담아지는걸 확인이 가능하다

newNumberMatcherList 처럼 값을 사용 하고 싶은곳에 따로 사용 하여야 한다 (여러번 사용불가)

참고

https://coding-factory.tistory.com/529

https://gngsn.tistory.com/53

https://girawhale.tistory.com/77

Uploaded by Notion2Tistory v1.1.0

Java Optional2

Eco — Thu, 3 Feb 2022 15:28:32 +0900

<피드백 언제나 환영합니다! 댓글 달아주세요 감사합니다>

Java Optional 1 에서 정확한 설명을 하지 못해서 보충 설명 및 사용시 주의사항 위주로 이야기 해보려고 합니다.

orElse, orElseGet두 메소드의 차이점을 쉽게 생각하려다보니 놓친 부분이 있다.orElseGet(Supplier ...) → other.get()이 실행이된다 → value 값이 null 인 경우에 method 가 실행이 되는형태 (method 가 들어온 형태라면)
orElse(T other) → 안에 있는 값이 무조건 실행되는걸 확인할 수있다. 즉, println() 과 같은 형태이다. 즉 T other 에 method가 들어간 형태이기 때문 (반환값이 있는)

Optional.steam() 통해 스트림을 생성(Java 9부터 추가) → Optional은 stream용 메서드가 아니다.

Java Optional 주의사항

앞전에도 말했듯이 Optional은 Wrapper class 입니다 → Wrapper class 는 비용문제가 발생 → 객체 생성, 참조 비용...

primitive type 비해 비싸다 필요할 때만 써야합니다. Effective Java 에서 Optional 활용에 따르면

Optional 활용1 - 기본값(defalut)를 정해둘 수 있다.
- optionalS1.orElse(”이름 없음”);

Optional 활용2 - 원하는 예외를 던질 수 있다.
- 값이 없는경우 원하는 예외를 던져 사용이 가능하다
- optionalS1.orElseThrow(Exception::new);

Optional 활용3 - 항상 값이 채워져 있는 경우
- .get()을 이용하여 출력 → 값이 있다고 확신이 들때만 사용

Optional 활용4 - 기본값을 설정하는 비용이 큰 경우
- 활용1 에서 기본값 비용이 클경우 사용

Java Optional 안티 패턴

Collection, Stream, 배열은 Optional로 되도록이면 감싸지 말자
- List 는 값을 담아두는 그릇 → 빈 ArrayList를 반환하면 된다. → Optional 처리코드를 넣지 않아도 된다.

Optional을 Map의 키나 값으로 사용 금지
- key 자체가 없는경우
- key는 있지만, 속이 빈 Optional 인경우
→ 쓸데없이 복잡도만 높아지게되고 쓸모없는짓중 하나입니다.

isPresent() 를 사용하지 말자
- if 문을 벗어나기위해 Optional을 사용한거다.. 이점을 꼭 생각해야 한다.

추가적으로 알아야 할 것들

박싱된 기본타입 사용시 → OptionalInt, OptionalDouble, OptionalLong 사용

값을 반환하지 못할 가능성이 있고, 호출할 때마다 반환값이 없을 가능성을 염두에 둬야하는 메소드 → Optional을 반환해야하는 상황일 수 있다. (JpaRepository save() 같은 기능들)

추가 Optional Method

Java Optional 1 :: Eco 의 개발일기 에서 get(), orElseThorw(), orElse(), orElseGet()외 다른 method를 확인 해보겠습니다.

예제 class

@Data
static class Team{
	Subject subject;
	List<Member> memberList;
}
@Data
static class Subject{
	String gameName;
}
@Data
static class Member {
	Long id;
	String name;
	String email;
}

void ifPresent(Consumer<? super T> consumer)
- Optional 내부의 값이 있는 경우 consumer 함수를 실행

Optional<T> filter(Predicate<T> predicate)

Optional에 filter 조건을 걸어 조건에 맞을 때만 Optional 내부 값이 있음

조건이 맞지 않으면 Optional.empty를 리턴

Optional.filter() 예제

Member member1 = new Member(1L, "hello1");
Member member2 = new Member(null, null);
List<Member> memberList = new ArrayList<>(List.of(member1, member2));

Subject subject = new Subject();
subject.setGameName("LOL");

Team team = new Team();
team.setMembers(memberList);
team.setSubject(subject);
Team team1 = Optional.ofNullable(team)
        .filter(item -> item.getSubject().getGameName().equals("LOL"))
        .orElse(null);
System.out.println("team1 = " + team1);
/*team1 = OptionalJava.Team(subject=OptionalJava.Subject(gameName=LOL), 
					members=[OptionalJava.Member(id=1, name=hello1, email=null), 
										OptionalJava.Member(id=null, name=null, email=null)])
/*

Optional<U> map(Funtion<? super T, ? extends U> f)

Optional 내부의 값을 Function을 통해 가공

Optional.empty를 리턴

Optional.map() 예제

Team team = new Team();
String gameObject = Optional.ofNullable(team)
								.map(Team::getSubject)
                .map(Subject::getGameName)
                .orElse("game 종목이 없네");
System.out.println("gameObject = " + gameObject );
/* 게임종목이 없네/*

Stream을 이용한 Optional중간에 비어있는 Optional 객체가 반환되는 경우, Stream.empty()가 반환되며 함수 체이닝이 더 이상 진행되지 않는점을 유의하자. 스트림 연산이 멈춘다.
- Stream 예제 코드
```
List.of(4, 3, 2, 5)
		.stream() // stream으로 복사해서 사용가능하다.
		.map(value -> value > 2 ? Optional.of(value) : Optional.empty())
		.flatMap(Optional::stream)
		.forEach(System.out::println);
/* 3
	 4
	 5 */
```
물론 람다식과 메서드 레퍼런스는 선택사항이다. 꼭 필요하다면 익명클래스를 사용해도 상관없다.

참고

#12. Optional API (Null값 처리) (tistory.com)

Item 55. 옵셔널 반환은 신중히 하라 | Carrey`s 기술블로그 (jaehun2841.github.io)

Uploaded by Notion2Tistory v1.1.0

Tomcat SSL 적용 (Windows)

Eco — Wed, 26 Jan 2022 18:23:00 +0900

협력업체가 http → https 로 변경을 원하는 상황입니다. 검증된 SSL 인증서를 구하여 적용 하겠으나, test를위해 임의의 인증서를 만들어보고 적용해보겠습니다. (window 입니다, Linux는 나중에...)

openSSL을 사용하여 임이의 인증서를 만들 예정입니다 (아래 링크에서openSSL 사용법이 있습니다.)

OpenSSL 자주 쓰는 명령어(command) 및 사용법, tip 정리

RHEL/CentOS Linux 는 기본 패키지에 포함되어 있으므로 별도 설치를 안해도 됩니다. Windows 나 기타 Unix 에서 설치는 OpenSSL 컴파일(compile) & 빌드(build) 참고하세요 설치된 openssl 의 version 은 다음 명령어로 확인할 수 있습니다.

https://www.lesstif.com/software-architect/openssl-command-tip-7635159.html

OpenSSL을 다운로드 받는거보다 gitBash에서 지원을 해주니 그부분을 사용 하겠습니다.

#gitBash, 원하는 디렉토리에 들어가서 실행 하면 됩니다
openssl version // 버전확인이 가능합니다.

윈도우에서 openssl pkcs export 멈춤현상 → window 터미널 입출력 문제 → 유닉스 터미널 동작필요(winpty) winpty bash

openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certificate.pem
개인키 생성 → 이름, city 등등 정보를 적어야 한다

입력 값(test형태로 입력 바꿔도 됩니다.)

Country Name (2 letter code) [AU]:82
State or Province Name (full name) [Some-State]:testName
Locality Name (eg, city) []:busan
Organization Name (eg, company) [Internet Widgits Pty Ltd]:testCompany
Organizational Unit Name (eg, section) []:testSection
Common Name (e.g. server FQDN or YOUR name) []:TEST
Email Address []:test@gmail.com

openssl x509 -text -noout -in certificate.pem
작성된 인증서 검토

openssl pkcs12 -inkey key.pem -in certificate.pem -export -out certificate.p12
pkcs12(p12) 로 인증서 결합

openssl pkcs12 -in certificate.p12 -noout -info
pkcs12 유효성 검증

1. Spring (내장톰켓)에 적용해 봅시다.

먼저 전 ui와 api단을 나눠서 진행 하겠습니다 → 둘다 ssl 을 적용시킨후 하고 싶지만 아직 ui 쪽만 가능합니다. → api와의 ssl 통신은 다음에 적용되는 즉시 포스팅 해보겠습니다.

application.properties

server.ssl.enabled=true
#파일위치
server.ssl.key-store=D:/apach/certificate.p12
#비밀번호
server.ssl.key-store-password=test123

첫 사진은 http로 접근시 입니다 두번재 사진은 https 로 접근시 입니다.

https 로 접근시 임의로 만든 ssl 이기 때문에 인증이 되지않아 접근이막힙니다. 이부분을 연결로 하여 들어가면 가능 합니다.

→ 두번재 사진처럼 주의요함이 뜨는게 정상입니다 (chrome 에서는 인증을 안해주었기 때문에)

http 접근

https 접근

2. 외장 Tomcat을 이용한 배포 입니다.

Apache Tomcat War 배포 (Window) 에서 톰켓을 배포한 이후의 상황으로 하겠습니다.

현재 톰켓 버전은 8.5로 하였습니다 → 나중에 톰켓 10 버전도 업로드 할 예정입니다.

→ application.properties 에서 ssl 설정을 하여도 외장 tomcat에서는 적용이 안됩니다. 따로 지정을 해줘야 합니다. 주의 사항이 있는데 ssl 적용을 하고 war 로 압축을 진행할 예정이면, 파일위치 비밀번호를 외장톰켓 설정과 맞춰줘야 합니다.

1. tomcat/conf/server.xml

<Connector port="기존 포트 번호" protocol="HTTP/1.1"
		connectionTimeout="20000"
		redirectPort="SSL 적용 포트 번호" />

<Connector port="SSL 적용 포트 번호" protocol="HTTP/1.1" SSLEnabled="true"
		maxThreads="150" scheme="https" secure="true"
		keystoreFile="파일 경로"
		keystorePass="ssl 비밀번호"
		clientAuth="false" sslProtocol="TLS" />

위코드를 추가 하면됩니다. 여기서 “기존 포트 번호” : 80, “SSL 적용 포트 번호” : 443 으로 진행 하겠습니다.

예시 코드

<Connector port="80" protocol="HTTP/1.1"
		connectionTimeout="20000"
		redirectPort="443" />

<Connector port="443" protocol="HTTP/1.1" SSLEnabled="true"
		maxThreads="150" scheme="https" secure="true"
		keystoreFile="D:/apach/certificate.pkcs12"
		keystorePass="test123"
		clientAuth="false" sslProtocol="TLS" />

80 → http 접속시 포트번호 없이 접근

443 → https 접속시 포트번호 없이 접근

위 포트 외 다른 포트로 변경이 됩니다 그럴경우 도메인 뒤에 포트 번호를 붙여야 합니다 ex> localhost:8090/...

2. tomcat/conf/web.xml

conf/web.xml

<?xml version="1.0" encoding="UTF-8"?>
....
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
	http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
	version="3.1">
....
<!-- 이 위치에 session-config 위에 코드를 적어줘야 합니다 -->
/* 코드 적는 위치 */
<session-config>
	<session-timeout>30</session-timeout>
	</session-config>
....
<mime-mapping>
	<extension>123</extension>
	<mime-type>application/vnd.lotus-1-2-3</mime-type>
</mime-mapping>
<mime-mapping>
	<extension>3dml</extension>
	<mime-type>text/vnd.in3d.3dml</mime-type>
	</mime-mapping>
....

위 /* 코드 적는 위치 */ 에 아래 코드를 넣으면 됩니다.

<!-- http -> https 로 리다이렉트 하게 해줍니다. -->
<security-constraint>
	<web-resource-collection>
		<web-resource-name>HTTP</web-resource-name>
		<url-pattern>/*</url-pattern>
	</web-resource-collection>
	<user-data-constraint>
		<transport-guarantee>CONFIDENTIAL</transport-guarantee>
	</user-data-constraint>
</security-constraint>
<!-- 특정 리소스 /images/*, /css/* 리소스는 http or https 모두 처리됩니다. -->
<security-constraint>
	<web-resource-collection>
		<web-resource-name>HTTPS or HTTP</web-resource-name>
		<url-pattern>/images/*</url-pattern>
		<url-pattern>/css/*</url-pattern>
	</web-resource-collection>
	<user-data-constraint>
		<transport-guarantee>NONE</transport-guarantee>
	</user-data-constraint>
</security-constraint>

참고

https://www.ibm.com/docs/ko/api-connect/5.0.x?topic=profiles-generating-self-signed-certificate-using-openssl

[Spring Boot] 24. https TLS SSL 적용하기 (tistory.com)

Uploaded by Notion2Tistory v1.1.0