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

[문자열 덧셈 계산기] 조건희 미션 제출합니다 #2

Open
wants to merge 47 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
dd4b867
docs:README.md update
whrjsgml0000 Oct 15, 2024
dac220d
feat:문자열 입력 기능 추가
whrjsgml0000 Oct 15, 2024
9c52493
feat:Calculator 클래스 추가, checkPlusSeparator() 메서드 추가
whrjsgml0000 Oct 15, 2024
2e7cd6d
docs:update README.md
whrjsgml0000 Oct 15, 2024
0fe1bba
feat:separate 메서드 추가
whrjsgml0000 Oct 15, 2024
dedece8
docs:update README.md
whrjsgml0000 Oct 15, 2024
061b121
docs:update README.md
whrjsgml0000 Oct 15, 2024
fc10e29
feat:hasNaN 메서드 추가
whrjsgml0000 Oct 15, 2024
2fc1483
docs:update README.md
whrjsgml0000 Oct 15, 2024
3a094f5
feat:sum 메서드 추가
whrjsgml0000 Oct 15, 2024
5f2ea86
style:clean code
whrjsgml0000 Oct 16, 2024
b9b2316
refactor:separate 메소드 else 문 제거
whrjsgml0000 Oct 16, 2024
fdb0c7c
comment:Calculator 클래스에 주석 추가
whrjsgml0000 Oct 16, 2024
a033f18
test:add test cases
whrjsgml0000 Oct 16, 2024
bef0412
fix:문자열을 아무 것도 주지 않았을 때 예외 처리 추가
whrjsgml0000 Oct 16, 2024
93e9eaa
refactor:디ë레이어 기반으로 ë디렉토리 나누는 중.
whrjsgml0000 Oct 17, 2024
0ea8127
refactor:코드 옮기기 끝
whrjsgml0000 Oct 17, 2024
000c1f8
fix:ë¨merge conflict í• 해결
whrjsgml0000 Oct 17, 2024
338341c
주석 달기
whrjsgml0000 Oct 17, 2024
1f14323
docs:update README.md
whrjsgml0000 Oct 17, 2024
50c64a7
fix:구분자 사이에 문자열이 없는 경우 처리 추가
whrjsgml0000 Oct 17, 2024
93954de
test:구분자 사이에 문자열이 없는 경우 테스트 추가
whrjsgml0000 Oct 17, 2024
a9ee173
refactor:메인에 있던 코드 컨트롤러로 옮김.
whrjsgml0000 Oct 19, 2024
48eaf2d
refactor:input 메서드와 output 메서드로 기능 분리
whrjsgml0000 Oct 19, 2024
c7a6f7f
style:코드 정리
whrjsgml0000 Oct 19, 2024
5e7a559
test:테스트 케이스 추가
whrjsgml0000 Oct 19, 2024
955ccb6
docs:Update README.md
whrjsgml0000 Oct 19, 2024
358957c
comment:주석 한글화함.
whrjsgml0000 Oct 19, 2024
2af965b
refator:불필요한 else 문 삭제
whrjsgml0000 Oct 19, 2024
ba18632
docs:Update README.md
whrjsgml0000 Oct 19, 2024
31920dd
2중 for 문 제거. stream 사용
whrjsgml0000 Oct 19, 2024
71f7fed
docs:Update README.md
whrjsgml0000 Oct 19, 2024
e9e5596
refactor:Configuration 클래스에 싱글톤 패턴 적용
whrjsgml0000 Oct 19, 2024
f5514b5
refactor:CalculatorService 클래스의 sum() -> add() 로 변경
whrjsgml0000 Oct 20, 2024
9a99a54
refactor:CalculatorController 클래스의 변수이름 변경
whrjsgml0000 Oct 20, 2024
40b3489
refactor:view를 따로 관리하도록 분리함
whrjsgml0000 Oct 20, 2024
8451b22
refactor:사용하지 않는 import 문 제거
whrjsgml0000 Oct 20, 2024
98313ec
refactor:오류 메세지 작성
whrjsgml0000 Oct 20, 2024
5897fa6
refactor:변수 이름 변경
whrjsgml0000 Oct 20, 2024
0ea7745
refactor:CalculatorValidator 클래스 생성 및 로직 분리
whrjsgml0000 Oct 20, 2024
a4d6f60
refactor:상수 관리 enum 클래스 생성
whrjsgml0000 Oct 20, 2024
ce6ed73
refactor:변수 이름 변경
whrjsgml0000 Oct 20, 2024
831a58f
refactor:클래스 이름 변경 및 그에 따른 변수 이름 변경
whrjsgml0000 Oct 20, 2024
c145fc0
refactor:Separator 클래스 생성 및 로직 분리
whrjsgml0000 Oct 20, 2024
c677162
comment:주석 추가
whrjsgml0000 Oct 20, 2024
9ed071b
docs:Update README.md
whrjsgml0000 Oct 20, 2024
f4a9c3d
docs:Update README.md
whrjsgml0000 Oct 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 58 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,58 @@
# java-calculator-precourse
# java-calculator-precourse

# Project Directory
calculator
┣ config
┃ ┗ Configuration.java
┣ constant
┃ ┗ CalConst.java
┣ controller
┃ ┗ CalculatorController.java
┣ dto
┃ ┗ CheckSeparatorDto.java
┣ service
┃ ┣ separator
┃ ┃ ┗ Separator.java
┃ ┣ validator
┃ ┃ ┗ Validator.java
┃ ┗ CalculatorService.java
┣ view
┃ ┣ InputView.java
┃ ┗ OutputView.java
┗ Application.java

## 구현할 기능 목록

1. 문자열을 입력 받는 기능
2. 문자열에 추가 구분자 입력이 있는지 확인하는 기능
3. 문자열을 구분자를 기준으로 나누는 기능
4. 구분자로 나눠진 문자열에 숫자 외의 다른 문자가 있는지 확인하는 기능 있으면 IllegalArgumentException
5. 나눠진 숫자를 더하는 기능

## 테스트 필요 하다 생각 되는 것들

- [x] 문자열을 아무 것도 주지 않았을 때
- [x] 추가 구분자로 숫자를 줬을 때
- [x] 소수 넣어 보기(추가 구분자로 .을 줬을 때와 아닐 때)
- [x] 역슬래시(이스케이프 문자를 구분자로 줬을 때)
- [x] 구분자 사이에 숫자가 없을 때
Comment on lines +34 to +38

Choose a reason for hiding this comment

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

예외 케이스를 되게 다양하게 짜신 것 같습니다 👍

특히 소수 넣어 보기 같은 경우는 생각을 더 해보게 되는 것 같아요. 덧셈 계산기라는 특성상 추후 발전을 시킨다면 소수도 계산을 할 수 있어야 할텐데, 이 때 어떤 기준으로 소수를 분리할 지에 대해 고민이 되네요!

좋은 생각거리를 주셔서 감사합니다 🔥


## 확인 필요

### 1. 커스텀 구분자가 여러 개라면?
현재 만들어진 로직은 커스텀 구분자가 한 개인 경우만을 받고 있으나 그렇지 않을 수도 있음.
Comment on lines +40 to +43

Choose a reason for hiding this comment

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

1번은 진짜 생각도 못 했네요 ㄷㄷㄷ 만약 커스텀 구분자가 여러 개라면 //;\n//-\n1-2;3 이런 식으로 문자열 앞 쪽에 선언부를 여러 개 써야하지 않을까?라는 생각이 듭니다!

만약에 //와 \n 사이에 두 개가 들어가면 그건 따로 떨어뜨려서 구분을 해야하나?
//ea\n1ea2ea3ea 이 주어지면 ea로 묶어서 구분자로 사용해야 하나?

### 2. 커스텀 구분자에 숫자가 들어온다면?
당연히 계산기라면 커스텀 구분자에 숫자가 들어오면 안되긴 함.
커스텀 구분자에 숫자가 들어오는 경우 IllegalArgumentException 해야하는가?
아니면 구분자로 인식하고 계산시켜야 하는가?
지금은 계산하도록 만들어둠.

### 3. 아무 입력도 하지 않았다면?
입력이 없으면 0을 출력하도록 했음. 근데 IllegalArgumentException 해야하는지?

### 4. 구분자 사이에 숫자가 없다면?
현재는 사이에 숫자가 없다면 0으로 인식하고 계산을 진행하도록 하였음.
이것도 throw 해야하는 경우인가?
8 changes: 7 additions & 1 deletion src/main/java/calculator/Application.java
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
package calculator;

import calculator.config.Configuration;
import calculator.controller.CalculatorController;

public class Application {
private static final Configuration CONFIGURATION = Configuration.getInstance();

public static void main(String[] args) {
// TODO: 프로그램 구현
CalculatorController calculatorController = CONFIGURATION.getCalculatorController();
calculatorController.input();
}
}
19 changes: 19 additions & 0 deletions src/main/java/calculator/config/Configuration.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package calculator.config;

import calculator.controller.CalculatorController;

public class Configuration {
private static final Configuration CONFIGURATION = new Configuration();
private final CalculatorController calculatorController = new CalculatorController();

private Configuration() {
}

public static Configuration getInstance() {
return CONFIGURATION;
}

public CalculatorController getCalculatorController() {
return calculatorController;
}
}
19 changes: 19 additions & 0 deletions src/main/java/calculator/constant/CalConst.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package calculator.constant;

public enum CalConst {
MINIMUM_LENGTH_IF_EXIST_CUSTOM_SEPARATOR(5),
START_INDEX_OF_CALCULATING(5),
END_INDEX_OF_CUSTOM_SEPARATOR(3),
INDEX_OF_CUSTOM_SEPARATOR(2),
;

private final int value;

CalConst(int value) {
this.value = value;
}

public int value() {
return value;
}
}
29 changes: 29 additions & 0 deletions src/main/java/calculator/controller/CalculatorController.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package calculator.controller;

import calculator.service.CalculatorService;
import calculator.view.InputView;
import calculator.view.OutputView;

public class CalculatorController {
private final CalculatorService calculatorService;
private final InputView inputView;
private final OutputView outputView;

public CalculatorController() {
this.inputView = new InputView();
this.outputView = new OutputView();
this.calculatorService = new CalculatorService();
}

public void input() {
String s = inputView.inputString();
inputView.close();
int addedResult = calculatorService.add(s);
output(addedResult);
}

private void output(int i) {
outputView.outputInteger(i);
}

}
22 changes: 22 additions & 0 deletions src/main/java/calculator/dto/CheckSeparatorDto.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package calculator.dto;

public class CheckSeparatorDto {
private String inputString;
private String customSeparator = null;

public String getInputString() {
return inputString;
}

public void setInputString(String inputString) {
this.inputString = inputString;
}

public String getCustomSeparator() {
return customSeparator;
}

public void setCustomSeparator(String customSeparator) {
this.customSeparator = customSeparator;
}
}
40 changes: 40 additions & 0 deletions src/main/java/calculator/service/CalculatorService.java

Choose a reason for hiding this comment

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

현재 CalculatorService에서 원본 문자열에 대한 파싱 작업을 같이 하고 계신 것으로 보입니다!

저 같은 경우에는 계산 기능과 문자열 가공 기능을 다른 클래스로 분리해봤습니다. 아무래도 우리가 실제 계산기를 사용할 때 문자열이 아닌 숫자만을 입력하는 것처럼, 계산기의 본 기능은 "계산"이고, "계산을 위해 숫자를 분리해내는 일"은 다른 클래스가 가져야 할 책임이라고 생각했기 떄문입니다!

살짝 참고해주시면 좋을 것 같습니다...!

Choose a reason for hiding this comment

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

딱 외부에서 사용할 메서드만 public으로 선언하시고, 나머지 하위 메서드들은 private으로 선언하신 게 인상깊네요!

Choose a reason for hiding this comment

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

계산기의 본 기능은 "계산"이고, "계산을 위해 숫자를 분리해내는 일"은 다른 클래스가 가져야 할 책임이라고 생각했기 떄문입니다!

동감합니다..!
한 클래스가 많은 책임을 가지면 확장성 및 일관성을 저해할 수 있어요.
추후 유지보수를 위해 기능을 나눠 다른 클래스로 책임을 분리하는게 좋아보입니다!
그게 객체지향이 가지는 큰 장점이라고 생각합니다😀

Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
package calculator.service;

import calculator.dto.CheckSeparatorDto;
import calculator.service.separator.Separator;
import calculator.service.validator.Validator;

public class CalculatorService {
private final Validator validator = new Validator();
private final Separator separator = new Separator();


/**
* 덧셈 로직을 순차적으로 진행한다.
*/
public int add(String inputString) {
CheckSeparatorDto checkSeparatorDto = new CheckSeparatorDto();
checkSeparatorDto.setInputString(inputString);
separator.checkCustomSeparator(checkSeparatorDto);
String[] separatedString = separator.separate(checkSeparatorDto);

validator.hasNaN(separatedString);
return sumSeparatedStringArr(separatedString);
}

/**
* 문자열을 int 형으로 바꾼 뒤 합한다.
*
* @param separatedStringArr 숫자로만 이루어진 문자열 배열을 입력한다.
* @return 합한다.
*/
private int sumSeparatedStringArr(String[] separatedStringArr) {
int sum = 0;
for (String separatedString : separatedStringArr) {
if (!separatedString.isEmpty()) {
sum += Integer.parseInt(separatedString);
}
}
return sum;
}
Comment on lines +31 to +39

Choose a reason for hiding this comment

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

for문 대신 stream문을 사용할 수도 있습니다! 지금은 간단한 로직이라 별 차이가 안 나지만, 나중에 for문 안에 있는 로직이 복잡해지면 stream 사용을 고려해보셔도 좋을 것 같아요 😀

private int sumSeparatedStringArr(String[] separatedStringArr) {
    return Arrays.stream(separatedStringArr)
            .filter(s -> !s.isEmpty())       // 빈 문자열 필터링
            .mapToInt(Integer::parseInt)     // 문자열을 정수로 변환
            .sum();                          // 합계 계산
}

Copy link
Author

Choose a reason for hiding this comment

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

for문 대신 stream문을 사용할 수도 있습니다! 지금은 간단한 로직이라 별 차이가 안 나지만, 나중에 for문 안에 있는 로직이 복잡해지면 stream 사용을 고려해보셔도 좋을 것 같아요 😀

private int sumSeparatedStringArr(String[] separatedStringArr) {
    return Arrays.stream(separatedStringArr)
            .filter(s -> !s.isEmpty())       // 빈 문자열 필터링
            .mapToInt(Integer::parseInt)     // 문자열을 정수로 변환
            .sum();                          // 합계 계산
}

가독성도 그렇고 stream 이 직관적인 면이 있어서 보기 이쁘다고 생각을 해요. 코틀린에서는 stream 문이 워낙 편해서 자주 썼었는데 자바는 좀 손에 안익더라고요... 그래도 써보려고 노력은 해봐야죠. 조언 감사합니다!

}
47 changes: 47 additions & 0 deletions src/main/java/calculator/service/separator/Separator.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package calculator.service.separator;

import calculator.constant.CalConst;
import calculator.dto.CheckSeparatorDto;

public class Separator {

/**
* 커스텀 구분자가 있는지 확인한다. 만약 있다면, checkSeparatorDto.customSeparator 에 null 대신 커스텀 구분자를 넣는다. 또한,
* checkSeparatorDto.inputString 에 커스텀 구분자를 확인하는 부분을 제거한 문자열을 넣는다.
*
* @param checkSeparatorDto inputString 만 set 되어 있는 dto.
*/
public void checkCustomSeparator(CheckSeparatorDto checkSeparatorDto) {
String inputString = checkSeparatorDto.getInputString();
String customSeparator;

if (inputString.length() >= CalConst.MINIMUM_LENGTH_IF_EXIST_CUSTOM_SEPARATOR.value()
&& inputString.startsWith("//")
&& inputString.startsWith("\\n", CalConst.END_INDEX_OF_CUSTOM_SEPARATOR.value())) {
customSeparator = String.valueOf(inputString.charAt(CalConst.INDEX_OF_CUSTOM_SEPARATOR.value()));
inputString = inputString.substring(CalConst.START_INDEX_OF_CALCULATING.value());

checkSeparatorDto.setCustomSeparator(customSeparator);
checkSeparatorDto.setInputString(inputString);
}
}

/**
* 문자열을 구분자를 이용해 나눈다.
*
* @param checkSeparatorDto 커스텀 구분자(or null)와 커스텀 구분자 확인 부분을 제거한 문자열을 넣은 Dto.
* @return 구분자를 이용해 나눠진 문자열을 반환한다. 이 문자열에는 숫자 외의 문자가 존재할 수 있다. 계산에 이용하려면 추가적인 확인 과정이 필요하다.
*/
public String[] separate(CheckSeparatorDto checkSeparatorDto) {
String customSeparator = checkSeparatorDto.getCustomSeparator();
String inputString = checkSeparatorDto.getInputString();

if (customSeparator == null) {
return inputString.split("[:,]");
}
if (customSeparator.equals("\\")) {
return inputString.split("[:," + customSeparator.repeat(2) + "]");
}
return inputString.split("[:," + customSeparator + "]");
}
}
19 changes: 19 additions & 0 deletions src/main/java/calculator/service/validator/Validator.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package calculator.service.validator;

import java.util.Arrays;

public class Validator {

/**
* 숫자가 아닌 문자열이 있는지 확인한다. 만약 있다면 IllegalArgumentException 으로 처리한다.
*
* @param separatedStringArr 숫자 외의 문자가 있는지 확인하고 싶은 문자열을 입력한다.
*/
public void hasNaN(String[] separatedStringArr) {
if (Arrays.stream(separatedStringArr)
.flatMapToInt(String::chars)
.anyMatch(it -> it < '0' || it > '9')) {
throw new IllegalArgumentException("입력한 문자열에 구분자, 숫자 외의 문자가 존재합니다.");
}
}
}
14 changes: 14 additions & 0 deletions src/main/java/calculator/view/InputView.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package calculator.view;

import camp.nextstep.edu.missionutils.Console;

public class InputView {
public String inputString() {
System.out.println("덧셈할 문자열을 입력해주세요.");
return Console.readLine();
}

public void close() {
Console.close();
}
}
7 changes: 7 additions & 0 deletions src/main/java/calculator/view/OutputView.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package calculator.view;

public class OutputView {
public void outputInteger(int i) {
System.out.println("결과 : " + i);
}
}
72 changes: 67 additions & 5 deletions src/test/java/calculator/ApplicationTest.java
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package calculator;

import camp.nextstep.edu.missionutils.test.NsTest;
import org.junit.jupiter.api.Test;

import static camp.nextstep.edu.missionutils.test.Assertions.assertSimpleTest;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

import camp.nextstep.edu.missionutils.test.NsTest;
import org.junit.jupiter.api.Test;

class ApplicationTest extends NsTest {
@Test
void 커스텀_구분자_사용() {
Expand All @@ -19,13 +19,75 @@ class ApplicationTest extends NsTest {
@Test
void 예외_테스트() {
assertSimpleTest(() ->
assertThatThrownBy(() -> runException("-1,2,3"))
.isInstanceOf(IllegalArgumentException.class)
assertThatThrownBy(() -> runException("-1,2,3"))
.isInstanceOf(IllegalArgumentException.class)
);
}

@Override
public void runMain() {
Application.main(new String[]{});
}

@Test
public void 숫자_구분자_사용() {
assertSimpleTest(() -> {
run("//1\\n2:213");
assertThat(output()).contains("결과 : 7");
});
}

@Test
public void 탈출_문자_사용() {
assertSimpleTest(() -> {
assertThatThrownBy(() -> runException("1\\2:3"))
.isInstanceOf(IllegalArgumentException.class);
});
}

@Test
public void 탈출_문자_구분자_사용() {
assertSimpleTest(() -> {
run("//\\\\n1\\2:3,4");
assertThat(output()).contains("결과 : 10");
});
}

@Test
public void 마침표_구분자_사용() {
assertSimpleTest(() -> {
run("//.\\n1.2.4:3");
assertThat(output()).contains("결과 : 10");
});
}

@Test
public void 마침표_사용(){
assertThatThrownBy(() -> runException("1.2.3:4"))
.isInstanceOf(IllegalArgumentException.class);
}

@Test
public void 따옴표_구분자_사용() {
assertSimpleTest(() -> {
run("//\"\\n1\"2\"4:3");
assertThat(output()).contains("결과 : 10");
});
}

@Test
public void 구분자_사이에_문자열_없음() {
assertSimpleTest(() -> {
run("1,:2");
assertThat(output()).contains("결과 : 3");
});
}

@Test
public void 문자열_없음(){
assertSimpleTest(() -> {
run("\n");
assertThat(output()).contains("결과 : 0");
});
}
}