리팩토링 - 데드 코드 제거

쓰레기 청소

TL;DR: 사용하지 않는 함수, 상수 및 "경우에 따른" 코드를 제거하세요.

해결된 문제

• 데드 코드

• 경우에 따른 코드

• 유지보수성 감소

• 닻배

• 인지 부하

관련 코드 냄새

코드 스멜 09 - 데드 코드

맥시 콘티에리 ・ 2020년 10월 28일

#코드뉴비 #지도 시간

코드 스멜 54 - 앵커 보트

맥시 콘티에리 ・ 2021년 1월 6일

#코드뉴비 #웹개발 #지도 시간 #클린코드

코드 냄새 148 - 할 일

맥시 콘티에리 ・ 2022년 7월 13일

#자바스크립트 #웹개발 #초보자 #프로그램 작성

단계

1. 코드의 기능 적용 범위가 양호한지 확인하세요.

2. 코드를 검토하거나 정적 분석 도구를 사용하여 사용하지 않는 함수와 상수를 식별하세요.

3. 혹시 추가된 추측성 코드를 분석해 보세요.

4. 불필요하거나 사용하지 않는 것을 제거하세요.

5. 코드에 대해 포괄적인 회귀 테스트를 수행합니다.

샘플 코드

전에

from flask import Flask, jsonify, make_response

app = Flask(__name__)

HTTP_100_CONTINUE = 100
HTTP_202_ACCEPTED = 202  # Not used
HTTP_204_NO_CONTENT = 204 # Not Used
HTTP_302_FOUND = 302 # Not Used
HTTP_400_BAD_REQUEST = 400  # Not Used
HTTP_401_UNAUTHORIZED = 401 # Not Used
HTTP_403_FORBIDDEN = 403
HTTP_404_NOT_FOUND = 404
HTTP_410_GONE = 410
HTTP_500_INTERNAL_SERVER_ERROR = 500
HTTP_501_NOT_IMPLEMENTED = 501

probe_telemetry = {
    "temperature": {"solar_panels": 150, "instrument_1": 50},
    "position": {"x": 1000000, "y": 2000000, "z": 3000000, 
    "velocity": {"vx": 100, "vy": 200, "vz": 300}},
    "status": {"power_level": 95, "communication_status": "OK"}
}

@app.route('/api/v1/probe/telemetry', methods=['GET'])
def get_telemetry():
    return jsonify(probe_telemetry), HTTP_200_OK

# The following function is not invoked 
# and not implemented
# It is a dead placeholder
@app.route('/api/v1/probe/send_command', methods=['POST'])
def send_command():
    return jsonify({"message": "Command endpoint not implemented yet."}), 
       HTTP_501_NOT_IMPLEMENTED

@app.route('/api/v1/probe/data', methods=['GET'])
def get_data():
    return jsonify({"message": "Data not found"}), 
       HTTP_404_NOT_FOUND

@app.route('/api/v1/probe/redirect', methods=['GET'])
def redirect_endpoint():
    response = make_response(jsonify({"message": "Redirecting..."}), 
       HTTP_301_MOVED_PERMANENTLY)
    response.headers['Location'] = '/api/v1/probe/telemetry'
    return response

@app.route('/api/v1/probe/not_modified', methods=['GET'])
def not_modified_endpoint():
    response = make_response(jsonify({"message": "Not Modified"}), 
       HTTP_304_NOT_MODIFIED)
    response.headers['ETag'] = 'some_etag'
    return response

@app.route('/api/v1/probe/gone', methods=['GET'])
def gone_endpoint():
    return jsonify({"message": "Resource permanently gone"}),
       HTTP_410_GONE

후에

# 1. Ensure your code has good functional coverage.

from flask import Flask, jsonify, make_response
from http import HTTPStatus

app = Flask(__name__)

# 2. Identify unused functions and constants 
# by reviewing your code or using static analysis tools.
HTTP_200_OK = HTTPStatus.OK
HTTP_301_MOVED_PERMANENTLY = HTTPStatus.MOVED_PERMANENTLY
HTTP_304_NOT_MODIFIED = HTTPStatus.NOT_MODIFIED
HTTP_404_NOT_FOUND = HTTPStatus.NOT_FOUND
HTTP_410_GONE = HTTPStatus.GONE
HTTP_501_NOT_IMPLEMENTED = HTTPStatus.NOT_IMPLEMENTED

probe_telemetry = {
    "temperature": {"solar_panels": 150, "instrument_1": 50},
    "position": {"x": 1000000, "y": 2000000, "z": 3000000, 
    "velocity": {"vx": 100, "vy": 200, "vz": 300}},
    "status": {"power_level": 95, "communication_status": "OK"}
}

@app.route('/api/v1/probe/telemetry', methods=['GET'])
def get_telemetry():
    return jsonify(probe_telemetry), HTTP_200_OK

# 3. Analyze the added speculative code, just in case.

@app.route('/api/v1/probe/send_command', methods=['POST'])
def send_command():
    return jsonify({"message": "Command endpoint not implemented yet."}), 
       HTTP_501_NOT_IMPLEMENTED

@app.route('/api/v1/probe/data', methods=['GET'])
def get_data():
    return jsonify({"message": "Data not found"}), 
      HTTP_404_NOT_FOUND

# 4. Remove anything unnecessary or unused.

# 5. Perform comprehensive regression testing on your code.

유형

[X] 반자동

안전

이 리팩토링은 변경 후 애플리케이션을 철저히 테스트하면 안전합니다. 정적 분석 도구를 사용하면 아직 사용 중인 항목을 제거하지 않도록 할 수 있습니다.

코드가 더 나은 이유는 무엇입니까?

사용하지 않는 요소를 제거하여 명확성을 높이고 복잡성을 줄입니다.

코드를 이해하고 유지 관리하기가 더 쉬워집니다.

추측적인 코드를 줄이면 현재의 실제 요구 사항에 계속 집중할 수 있습니다.

전단사를 어떻게 개선합니까?

데드 코드와 추측성 요소는 소프트웨어와 실제 모델 간의 전단을 깨뜨립니다.

이러한 요소를 제거하면 코드가
더욱 깔끔하고 현실에 가깝게 만드는 MAPPER.

제한사항

데드 코드를 제거하려면 실제로 사용되지 않는 코드라는 확신이 필요합니다.

이 프로세스는 정적 분석이나 철저한 코드베이스 지식에 의존하므로 강력한 도구가 없으면 오류가 발생할 수 있습니다.

AI를 사용한 리팩터링

Without Proper Instructions	With Specific Instructions
ChatGPT	ChatGPT
Claude	Claude
Perplexity	Perplexity
Copilot	Copilot
Gemini	Gemini

태그

• 블로터

관련 리팩토링

003 리팩토링 - 상수 추출

맥시 콘티에리 ・ 2022년 1월 2일

#앗 #프로그램 작성 #리팩토링 #클린코드

크레딧

Pixabay에서 가져온 Peter H의 이미지

---

이 글은 리팩토링 시리즈의 일부입니다.

손쉬운 리팩토링으로 코드를 개선하는 방법

맥시 콘티에리 ・ 2022년 10월 24일

#웹개발 #초보자 #프로그램 작성 #지도 시간

위 내용은 리팩토링 - 데드 코드 제거의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!