PL/Scope를 이용한 PL/SQL 코드 분석

개요

Oracle 데이터베이스의 PL/SQL 개발 및 유지보수 과정에서 코드 품질을 향상시키고 잠재적인 문제를 사전에 진단하는 것은 매우 중요합니다. PL/Scope는 Oracle Database에 내장된 강력한 분석 도구로서, PL/SQL 코드의 컴파일 시간에 식별자 사용 정보를 수집하여 다양한 메타데이터를 제공합니다. 이 가이드에서는 PL/Scope의 개념, 사용 방법, 활용 사례 및 고급 팁을 상세하게 설명하여 PL/SQL 개발자가 PL/Scope를 효과적으로 활용할 수 있도록 돕고자 합니다.

PL/Scope란 무엇인가?

PL/Scope는 PL/SQL 소스 코드 분석 도구로, PL/SQL 컴파일러가 소스 코드를 처리할 때 식별자(변수, 상수, 프로시저, 함수, 타입 등)의 사용 정보를 데이터베이스 내의 메타데이터 테이블에 기록합니다. 이 정보를 통해 개발자는 코드의 구조와 객체 간의 관계를 쉽게 파악하고, 코드 품질 및 유지보수성을 향상시킬 수 있습니다.

주요 특징

  • 코드 탐색: 식별자가 선언된 위치, 사용된 위치 등을 빠르게 찾을 수 있습니다.
  • 영향도 분석: 특정 객체가 변경될 때 영향을 받는 코드를 파악할 수 있습니다.
  • 코드 품질 검사: 사용되지 않는 변수, 불필요한 매개변수 등을 검출하여 코드 품질을 개선할 수 있습니다.
  • 메타데이터 통합: PL/SQL 코드와 관련된 다양한 메타데이터를 수집하고 관리할 수 있습니다.

PL/Scope 사용을 위한 사전 준비

필요 권한

PL/Scope를 사용하려면 다음과 같은 권한이 필요합니다.

  • CREATE PROCEDURE: PL/SQL 객체 생성 권한
  • EXECUTE ON DBMS_PLSCOPE_SETTINGS: PL/Scope 설정 변경 권한
  • SELECT 권한: PL/Scope 데이터 딕셔너리 뷰에 대한 조회 권한

PL/Scope 설정

PL/Scope를 활성화하려면 DBMS_PLSCOPE_SETTINGS 패키지를 사용하여 PLSCOPE_SETTINGS 초기화 매개변수를 설정해야 합니다.

EXEC DBMS_PLSCOPE_SETTINGS.SET_PLSCOPE_SETTINGS('IDENTIFIERS:ALL, STATEMENTS:ALL');
  • IDENTIFIERS:ALL – 모든 식별자 정보를 수집합니다.
  • STATEMENTS:ALL – 모든 SQL 문장 정보를 수집합니다.

설정을 변경한 후에는 PL/SQL 객체를 다시 컴파일해야 변경 사항이 적용됩니다.

PL/Scope 데이터 딕셔너리 뷰

PL/Scope는 분석 결과를 다음 데이터 딕셔너리 뷰를 통해 제공합니다.

  • ALL_IDENTIFIERS: 모든 사용 가능한 식별자 정보를 제공합니다.
  • USER_IDENTIFIERS: 현재 사용자가 소유한 식별자 정보를 제공합니다.
  • DBA_IDENTIFIERS: 데이터베이스 내의 모든 식별자 정보를 제공합니다(DBA 권한 필요).
  • ALL_STATEMENTS: 모든 SQL 문장 정보를 제공합니다.
  • USER_STATEMENTS: 현재 사용자가 실행한 SQL 문장 정보를 제공합니다.
  • DBA_STATEMENTS: 데이터베이스 내의 모든 SQL 문장 정보를 제공합니다(DBA 권한 필요).

PL/Scope 활용 방법

코드 탐색

ALL_IDENTIFIERS 뷰를 사용하여 특정 식별자의 사용 위치를 찾을 수 있습니다.

SELECT object_name, object_type, name, usage, usage_id, line, column FROM all_identifiers WHERE name = 'my_variable' AND object_name = 'my_procedure';

영향도 분석

특정 테이블이 변경될 때 영향을 받는 PL/SQL 객체를 파악할 수 있습니다.

SELECT DISTINCT object_name, object_type FROM all_identifiers WHERE referenced_name = 'my_table' AND referenced_type = 'TABLE';

코드 품질 검사

사용되지 않는 변수를 찾아 코드 품질을 개선할 수 있습니다.

SELECT name, object_name, object_type FROM all_identifiers WHERE usage = 'DECLARATION' MINUS SELECT name, object_name, object_type FROM all_identifiers WHERE usage <> 'DECLARATION';

PL/Scope 예제 코드

다음은 PL/Scope를 사용하여 PL/SQL 코드를 분석하는 간단한 예제입니다.

CREATE OR REPLACE PROCEDURE my_procedure (p_input NUMBER) AS l_variable NUMBER := 10; BEGIN IF p_input > l_variable THEN DBMS_OUTPUT.PUT_LINE('Input is greater than local variable'); ELSE DBMS_OUTPUT.PUT_LINE('Input is not greater than local variable'); END IF; END; / EXEC DBMS_PLSCOPE_SETTINGS.SET_PLSCOPE_SETTINGS('IDENTIFIERS:ALL, STATEMENTS:ALL'); ALTER PROCEDURE my_procedure COMPILE; SELECT object_name, name, type, usage, line FROM all_identifiers WHERE object_name = 'MY_PROCEDURE';

예제 실행 결과

위 쿼리는 다음과 같은 결과를 반환합니다.

OBJECT_NAME NAME TYPE USAGE LINE ------------- --------------- -------- ---------- ---- MY_PROCEDURE MY_PROCEDURE PROCEDURE FORMAL IN 1 MY_PROCEDURE P_INPUT PARAMETER FORMAL IN 1 MY_PROCEDURE L_VARIABLE VARIABLE VARIABLE 2

이 결과를 통해 my_procedure 내에서 사용된 식별자들의 타입, 사용처, 라인 번호 등을 확인할 수 있습니다.

고급 팁

PL/SQL Developer 연동

PL/SQL Developer와 같은 IDE는 PL/Scope 정보를 시각적으로 표시하여 코드 분석을 더욱 편리하게 만들어줍니다. PL/SQL Developer에서 PL/Scope 정보를 확인하려면, 코드 에디터에서 마우스 오른쪽 버튼을 클릭하고 "PL/Scope 정보 보기"를 선택하면 됩니다.

코드 복잡도 분석

PL/Scope 정보를 활용하여 코드의 복잡도를 측정하는 사용자 정의 스크립트를 작성할 수 있습니다. 예를 들어, 프로시저 내의 분기문(IF, CASE 등)의 개수를 세어 코드의 복잡도를 평가할 수 있습니다.

SQL Injection 취약점 검사

PL/Scope를 통해 수집된 SQL 문장 정보를 분석하여 SQL Injection 취약점을 검사할 수 있습니다. 특히, 동적 SQL 문장을 사용하는 부분에서 사용자 입력값을 검증하지 않고 그대로 사용하는 경우 SQL Injection에 취약할 가능성이 높습니다.

결론

PL/Scope는 PL/SQL 코드 분석에 유용한 강력한 도구입니다. PL/Scope를 활용하면 코드의 가독성, 유지보수성 및 보안성을 향상시킬 수 있으며, PL/SQL 개발 생산성을 높일 수 있습니다. PL/SQL 개발자라면 PL/Scope를 적극적으로 활용하여 고품질의 코드를 작성하고 관리하는 데 도움이 될 것입니다.

위로 스크롤