Қоқысты тазалаңыз

TL; DR: пайдаланылмаған функцияларды, тұрақты мәндерді және «дәл-жағдай» кодын жойыңыз.

Мәселелер шешілді

• Өлі код
• Тек жағдайдағы код
• Төменделген техникалық қызмет көрсету
• Анкерлік қайықтар
• Когнитивті жүктеме

Қатысты код иістері

Қадамдар

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] Жартылай автоматты

Нәресте қадамдарын орындауға және итерациялардағы қажет емес кодты жоюға болады.

Қауіпсіздік

Өзгерістерден кейін қолданбаңызды мұқият тексерсеңіз, бұл рефакторинг қауіпсіз. Статикалық талдау құралдары әлі пайдаланылып жатқан ештеңені жоймауға көмектеседі.

Неліктен код жақсырақ?

Пайдаланылмаған элементтерді жою арқылы анықтықты жақсартасыз және күрделілікті азайтасыз.

Сіздің кодыңызды түсіну және қолдау оңайырақ болады.

Алыпсатарлық кодты азайту сіздің назарыңызды ағымдағы, нақты талаптарға сақтайды.

Биеекцияны қалай жақсартады?

Өлі код және алыпсатарлық элементтер бағдарламалық жасақтама мен нақты әлем үлгісі арасындағы Bijection-ді бұзады.

Бұл элементтерді жою кодыңыздың MAPPER дәлдігін қамтамасыз етіп, оны таза және шындыққа жақындатады.

Шектеулер

Өлі кодты жою үшін оның шынымен пайдаланылмағанына сенімді болу керек.

Бұл процесс статикалық талдауға немесе сенімді құралдарсыз қатеге ұшырауы мүмкін мұқият код базасы біліміне негізделген.

AI бар рефактор

Тегтер

• Ісінушілер

Қатысты рефакторингтер

Несиелер

Сурет Pixabay сайтынан Питер Х

Бұл мақала Рефакторинг сериясының бөлігі болып табылады.