[논문]OCL을 이용한 자동화된 코드스멜 탐지와 리팩토링

김태웅; 김태공

doi:10.3745/kipstd.2008.15-d.6.825

OCL을 이용한 자동화된 코드스멜 탐지와 리팩토링
Automated Code Smell Detection and Refactoring using OCL 원문보기

정보처리학회논문지. The KIPS transactions. Part D. Part D, v.15D no.6, 2008년, pp.825 - 840

초록
AI-Helper

리팩토링은 내부적으로는 시스템의 품질을 개선하고, 외부적으로는 시스템의 기능을 유지하는 일종의 소프트웨어를 변경하는 과정이다. 이러한 리팩토링을 적용하여 기존 소스코드를 개선하기 위해서는 개선할 사항이 무엇인지를 아는 것이 우선이다. 이를 위해 Martin Fowler와 Kent Beck은 코드속의 나쁜 냄새(코드스멜)를 식별할 수 있는 방법을 제시 하였다. 또한 코드스멜을 탐지하고 어디에 어떤 리팩토링을 적용할 것인가를 결정하는 문제와 관련된 몇몇 연구가 발표되었다. 그러나 이러한 연구들은 코드스멜에 대한 명확한 표현이 부족하거나 한정된 코드스멜만을 탐지하는 단점이 있다. 그리고 리팩토링을 적용할 경우 행위보존을 위한 선행조건들의 표현방법이 리팩토링 절차에 포함되어 있거나 정형화되지 않아 행위보존의 모호함이 발생되는 단점을 가지고 있다. 이에 본 논문에서는 OCL을 이용하여 코드스멜의 정보를 정확히 명세화하고, OCL 번역기를 통해 코드스멜을 자동으로 탐지하여 리팩토링하는 프레임워크를 제안한다. 또한 적용사례를 통하여 자바소스코드속의 코드스멜을 OCL로 명세화하여 자동탐지하고, 리팩토링을 적용해 봄으로써 활용성과 효용성을 검증해본다.

Abstract ▼ AI-Helper

Refactoring is a kind of software modification process that improves system qualities internally but maintains system functions externally. What should be improved on the existing source codes should take precedence over the others in such a modification process using this refactoring. Martin Fowler and Kent Beck proposed a method that identifies code smells for this purpose. Also, some studies on determining what refactoring will be applied to which targets through detecting code smells in codes were presented. However, these studies have a lot of disadvantages that show a lack of precise description for such code smells and detect limited code smells only. In addition, these studies showed other disadvantages that generate ambiguity in behavior preservation due to the fact that a description method of pre-conditions for the behavior preservation is included in a refactoring process or unformalized. Thus, our study represents a precise specification of code smells using OCL and proposes a framework that performs a refactoring process through the automatic detection of code smells using an OCL interpreter. Furthermore, we perform the automatic detection in which the code smells are be specified by using OCL to the java program and verify its applicability and effectivity through applying a refactoring process.

주제어

AI 본문요약
AI-Helper

* AI 자동 식별 결과로 적합하지 않은 문장이 있을 수 있으니, 이용에 유의하시기 바랍니다.

문제 정의

리팩토링은 프로그램의 행위를 보존하면서 프로그램의 가독성, 구조, 성능, 유지보수성 등을 향상시키는 방법이다. 시스템의 기능을 유지하면서 시스템의 이해도를 높임과 동시에 유지보수를 보다 쉽게 할 수 있도록 내부 구조를 변경하는 것이다[1]. 이러한 리팩토링의 결과로 코드의 확장성, 모듈화, 재사용성, 유지보수성 같은 품질을 개선하여 개발의 속도를 높이고 코드 복잡도를 낮출 수 있다[2].
<표 1>과 같이 단순 코드스멜은 하나의 클래스에서 유추 가능한 반면 유도된 코드스멜은 여러 클래스간의 관계(상속 관계, 인스턴스, 메소드의 사용 및 필드의 사용 등)에서 정보를 추출하여 도출 가능하다. 이러한 코드스멜을 탐지하기 위한 여러 가지 연구들이 있으며, 그 장단점에 대해 알아본다.
이번 장에서는 관련연구로서 코드스멜의 정의 및 종류에 대해 알아보고, 본 논문에서 제안한 코드스멜 탐지 및 리팩토링과 관련된 연구들에 대해 살펴본다.
이에 본 논문에서는 OCL을 이용하여 코드스멜의 정보를 정확히 명세화하고, OCL번역기를 통해 코드스멜을 자동으로 탐지하여 리팩토링하는 프레임워크를 제안하였다.

가설 설정

가) t에서 사용하지 않는 필드이어야 한다.

제안 방법

이에 본 논문에서는 OCL[9]을 이용하여 코드스멜을 정의하고, 이를 자동탐지에 이용한다. 그리고 탐지된 소스코드에 리팩토링 절차를 거쳐 수정된 새로운 소스코드를 산출하는 프레임워크를 제안한다. 이를 위하여 소스코드를 AST[10]메타모델을 확장한 EAST(Extended Abstract Syntax Tree)메타모델 기반의 XMI(XML Metadata Interchange)[11]문서로 변환하고, 코드스멜에 대한 정의는 OCL을 이용하여 작성한다.
본 논문에서는 JavaAST메타모델을 확장한 JavaEAST메타 모델을 기반으로 소스코드를 XMI형태로 표현하고 있다. 따라서 JavaEAST모델에 접근 가능한 JAS(Java Abstract Syntax) API를 EMF기반으로 구현하여 리팩토링을 한다. (그림 5)와 (그림 6)은 본 논문에서 구현한 JavaEAST기반에서 생성된 XMI문서에 접근할 수 있는 API구조를 나타낸 클래스다이어그램과 소스코드의 일부이다.
이러한 과정을 통하여 탐지된 코드스멜은 리팩토링 절차를 통하여 소스코드가 수정된다. 리팩토링 절차는 본 논문에선 제안하고 구현한 EMF 기반의 JAS API를 통하여 이루어진다. 또한 리팩토링은 미니 리팩토링의 조합으로 가능하므로 리팩토링 요소를 재사용할 수 있으며, 새로운 리팩토링의 추가 또는 변경시 효율적이다.
리팩토링을 하기 위한 방법론을 제시하였으며, 리팩토링의 요소를 재사용하기 위해 작은 리팩토링으로 소형화 하였으며(MOON, Minimal Object Oriented Notation), 선행조건에 대한 명세를 클래스로 구현하여 정의하였다. 이는 이미 컴파일된 선행조건을 이용함으로써 효율성이 떨어진다.
본 논문에서 구현한 Java to AST Model Generator(XMI Generator)를 이용하여 JavaAST기반의 XMI문서를 산출하고 XMI Integrator를 이용하여 산출된 문서를 통합한다. 여기에 소스코드를 컴파일한 결과인 바이트코드(.
본 논문에서는 JavaAST메타모델을 확장한 JavaEAST메타 모델을 기반으로 소스코드를 XMI형태로 표현하고 있다. 따라서 JavaEAST모델에 접근 가능한 JAS(Java Abstract Syntax) API를 EMF기반으로 구현하여 리팩토링을 한다.
이는 리팩토링을 적용하는데 필요한 조건을 명세함으로써 리팩토링이 안전하게 진행될 수 있도록 하는데 있다. 본 논문에서는 이러한 조건들을 OCL을 사용하여 명세하였다. 이는 리팩토링 절차와 선행조건을 분리하여 정의함으로써 서로 독립적으로 사용가능하고 재사용의 효율을 높일 수 있다.
자바로 작성된 소스코드를 MoDisco[10]에서 제안한 JavaAST(Java Abstract Syntax Tree)로 나타내고(Java to AST Model Generator), 이를 본 논문에서 확장한 JavaEAST(Java Extended Abstract Syntax Tree)기반의 XMI문서로 변환한다(XMI Integrator). 여기에 OCL을 적용하여 코드스멜을 탐지하고, JAS API를 통하여 리팩토링을 적용하여 변경된 JavaEAST기반의 XMI문서를 산출한다. 이를 다시 JavaAST 기반의 XMI문서로 변환(XMI Separator)하고, 최종적으로 수정된 소스코드를 얻는다(AST to Java Code Generator).
이러한 Push Down Field 코드스멜 탐지와 리팩토링을 본 논문에서 제안한 방법을 이용하여 다음과 같은 절차로 진행한다.
그리고 탐지된 소스코드에 리팩토링 절차를 거쳐 수정된 새로운 소스코드를 산출하는 프레임워크를 제안한다. 이를 위하여 소스코드를 AST[10]메타모델을 확장한 EAST(Extended Abstract Syntax Tree)메타모델 기반의 XMI(XML Metadata Interchange)[11]문서로 변환하고, 코드스멜에 대한 정의는 OCL을 이용하여 작성한다. 작성된 OCL은 Eclipse 기반의 OCL 번역기(OCL Interpreter)[12]를 통하여 실행하고 자동탐지 한다.
이를 위하여 클래스들간의 관계, 속성 및 메소드에 대한 바인딩 정보를 표현하기 위한 JavaEAST모델을 제안하고, 이를 기반으로 코드스멜을 OCL로 정의하였다. 이는 나쁜 냄새에 대한 명확한 명세가 이루어진다는 장점 뿐만 아니라, 향후 새로운 코드스멜에 대한 추가 및 수정사항 발생시 OCL만을 정의하여 가능하게 함으로써 생산성 향상을 가져온다.
이번 장에서는 본 논문에서 제안한 프레임워크를 기반으로 하여 코드스멜 자동 탐지와 리팩토링을 적용해 보았다. 적용대상은 (그림 8)과 같은 데이터베이스 연결자 예제 프로그램으로 Push Down Field 코드스멜을 자동으로 탐지하고, 리팩토링하는 과정과 절차를 6단계로 나누어 적용하였다.
이번 장에서는 적용사례로서 본 논문에서 제안한 OCL을 이용한 자동화된 코드스멜 탐지와 리팩토링을 실제 적용하고, 수정된 소스코드를 얻는 절차 및 방법에 대해 기술한다. 적용할 대상은 (그림 8)과 같은 다양한 데이터베이스 연결자를 구성하는 예제 프로그램이다.
이번 절에서는 리팩토링을 적용하기 위한 방법으로 과 같이 미니리팩토링(Mini-Refactoring)을 정의하여, 이들의 조합으로 리팩토링이 이루어지도록 한다.
(그림 1)은 <표 2>에서의 요구사항을 만족하는 프레임워크이다. 자바로 작성된 소스코드를 MoDisco[10]에서 제안한 JavaAST(Java Abstract Syntax Tree)로 나타내고(Java to AST Model Generator), 이를 본 논문에서 확장한 JavaEAST(Java Extended Abstract Syntax Tree)기반의 XMI문서로 변환한다(XMI Integrator). 여기에 OCL을 적용하여 코드스멜을 탐지하고, JAS API를 통하여 리팩토링을 적용하여 변경된 JavaEAST기반의 XMI문서를 산출한다.
이를 위하여 소스코드를 AST[10]메타모델을 확장한 EAST(Extended Abstract Syntax Tree)메타모델 기반의 XMI(XML Metadata Interchange)[11]문서로 변환하고, 코드스멜에 대한 정의는 OCL을 이용하여 작성한다. 작성된 OCL은 Eclipse 기반의 OCL 번역기(OCL Interpreter)[12]를 통하여 실행하고 자동탐지 한다. 탐지된 코드스멜은 XMI문서를 조작하기 위해 구현한 EMF[13] 기반의 JAS(Java Abstract Syntax) API와 기초리팩토링(primitive refactoring) API를 이용하여 수행하며, 최종적으로 수정된 소스코드를 얻는다.
이번 장에서는 본 논문에서 제안한 프레임워크를 기반으로 하여 코드스멜 자동 탐지와 리팩토링을 적용해 보았다. 적용대상은 (그림 8)과 같은 데이터베이스 연결자 예제 프로그램으로 Push Down Field 코드스멜을 자동으로 탐지하고, 리팩토링하는 과정과 절차를 6단계로 나누어 적용하였다. 이와 같이 OCL로 코드스멜을 정의하고, OCL번역기를 통한 코드스멜의 자동탐지, 그리고 리팩토링을 자동화함으로써 수정된 소스코드를 산출할 수 있다.
코드스멜 탐지 도구를 이클립스 기반의 플러그인으로 개발하였다. 새로운 단순 코드스멜을 추가할 경우 제안한 5단계를 이용하여 프로그램을 작성해야 한다.
작성된 OCL은 Eclipse 기반의 OCL 번역기(OCL Interpreter)[12]를 통하여 실행하고 자동탐지 한다. 탐지된 코드스멜은 XMI문서를 조작하기 위해 구현한 EMF[13] 기반의 JAS(Java Abstract Syntax) API와 기초리팩토링(primitive refactoring) API를 이용하여 수행하며, 최종적으로 수정된 소스코드를 얻는다.

이론/모형

소스코드를 리팩토링하기 위해 소스코드를 JavaML[17] XML문서로 표현하고 있으며, XQuery[18]를 이용하여 리팩토링을 수행한다. 리팩토링 후의 시스템의 행위보존(Behavior Preservation)을 위한 선행조건(pre-condition)은 AFS(AnalysisFunctions)[19]을 사용하여 XQuery에 포함시켜 수행하고 있다.
이러한 클래스간의 관계에서 도출할 수 있는 정보를 OCL을 사용하여 명세화 한다<표 5>. 이러한 OCL명세는 본 논문의 3.1절에서 제시한 JavaEAST 메타모델을 기반으로 하고 있으며, 향후 특정한 코드속의 유도된 코드스멜을 정의하기 위한 조각들로 사용된다.
이에 본 논문에서는 OCL[9]을 이용하여 코드스멜을 정의하고, 이를 자동탐지에 이용한다. 그리고 탐지된 소스코드에 리팩토링 절차를 거쳐 수정된 새로운 소스코드를 산출하는 프레임워크를 제안한다.

성능/효과

하지만 이는 소스코드의 문법적인 정보만을 가지고 있으며, 특히 여러 개의 클래스들간의 관계를 분석해야 비로소 가능한 코드속의 유도된 코드스멜을 탐지하는데 문제점이 있다. 따라서 본 논문에서 구현한 XMI Integrator엔진을 통해 기존의 JavaAST모델을 JavaEAST기반의 모델로 변환 및 통합한다. 이 모델은 코드속의 유도된 코드스멜을 탐지 가능하도록 필드의 바인딩 정보를 포함하고, OCL로 자유로운 탐색(Navigation)이 가능하도록 그림 2, 3, 4와 같은 모델을 추가한 EMF[13]기반의 메타모델이다.
리팩토링 절차는 본 논문에선 제안하고 구현한 EMF 기반의 JAS API를 통하여 이루어진다. 또한 리팩토링은 미니 리팩토링의 조합으로 가능하므로 리팩토링 요소를 재사용할 수 있으며, 새로운 리팩토링의 추가 또는 변경시 효율적이다.
본 논문에서 제안하고 구현한 OCL을 이용한 코드스멜 자동탐지와 리팩토링을 위한 프레임워크는 OCL을 이용하기 때문에 소프트웨어의 재사용과 생산성 향상이라는 장점을 가진다. 이는 보다 유연한 리팩토링 자동화 도구의 개발에 필요한 중요한 선행연구가 될 것이다.

후속연구

본 논문에서 제안하고 구현한 OCL을 이용한 코드스멜 자동탐지와 리팩토링을 위한 프레임워크는 OCL을 이용하기 때문에 소프트웨어의 재사용과 생산성 향상이라는 장점을 가진다. 이는 보다 유연한 리팩토링 자동화 도구의 개발에 필요한 중요한 선행연구가 될 것이다. 향후 다양한 코드스멜에 대한 정의와 리팩토링을 적용해 봄으로써 메타모델의 검증과 더불어 보다 향상된 프레임워크를 개발해야 하겠다.
이는 보다 유연한 리팩토링 자동화 도구의 개발에 필요한 중요한 선행연구가 될 것이다. 향후 다양한 코드스멜에 대한 정의와 리팩토링을 적용해 봄으로써 메타모델의 검증과 더불어 보다 향상된 프레임워크를 개발해야 하겠다.

질의응답

핵심어	질문	논문에서 추출한 답변
	코드스멜은 무엇인가?	코드스멜은 소스코드에서 문제(Problem)가 될 수 있는 부분을 나타낸다. 그러나 코드스멜은 컴파일시에 나타나는 문법적인 오류나 경고와는 다르다. 예를 들어 나쁜 소프트웨어 디자인 또는 나쁜 프로그래밍 습관으로 인해 발생하는 소스코드를 말한다. 이러한 잘못된 프로그래밍 습관이나 디자인은 소프트웨어에 새로운 기능이 추가되거나 플랫폼의 변경시 소프트웨어 개발 비용이 증가되는 악영향을 가져온다.
	리팩토링은 어떤 작업인가?	리팩토링은 시스템의 기능을 유지하며 소스코드의 확장성, 모듈화, 재사용성, 유지보수성과 같은 품질을 개선하는 과정으로 일종의 소프트웨어를 변경하는 작업이다. 이러한 리팩토링을 적용하여 기존 소스코드를 개선하기 위해서는 개선할 사항이 무엇인지를 아는것이 우선이다.
	본 논문에서 OCL을 이용하여 코드스멜의 정보를 정확히 명세화하고, OCL번역기를 통해 코드스멜을 자동으로 탐지하여 리팩토링하는 프레임워크를 제안하기 위하여 무엇을 하였는가?	이를 위하여 클래스들간의 관계, 속성 및 메소드에 대한 바인딩 정보를 표현하기 위한 JavaEAST모델을 제안하고, 이를 기반으로 코드스멜을 OCL로 정의하였다. 이는 나쁜 냄새에 대한 명확한 명세가 이루어진다는 장점 뿐만 아니라, 향후 새로운 코드스멜에 대한 추가 및 수정사항 발생시 OCL만을 정의하여 가능하게 함으로써 생산성 향상을 가져온다.

참고문헌 (21)

Fowler, M. Refactoring. “Improving the Design of Existing Programs,” Addison-Wesley. 1999
Mens, T., Tourwe, T. “A Survey of Software Refactoring,” IEEE Transactions on Software Engineering, February, Vol.30, No.2. pp.126-139, 2004

상세보기
Joshua Kerievsky, “Refactoring to Patterns,” Addison Wesley, 2005
Martin Fowler, “Refactoring:Improving the Design Existing Code,” Addison Wesley, 1999
Stefan Slinger, “Code Smell Detection in Eclipse,” Delft University of Technology, March, 2005
Yoshio Kataoka, Michael D. Ernst, William G. Griswold, and David Notkin, “Automated Support for Program Refactoring using Invariants,” Proc. Int. Conf. On Software Maintenance, pp.736-743, 2001
Stephane Ducasse, Matthias Rieger, and Serge Demeyer, “A language independent approach for detecting duplicated code,” In Hongji Yang and Lee white, editors, Proc. Int'l Conf. Software Maintenance, IEEE Computer Society Press, pp.109-118, September, 1999
Frank Simon, Frank SteinbruUckner, and Clause Lewerent, “Metrics Based Refactoring,” In Proc. 5th European Conference on Software Maintenance and Reengineering, IEEE Computer Society Press, pp.30-38, 2001
Object Management Group, “Object Constraint Language Specification, Version 2.0,” http://www.omg.org/technology/ documents/formal/ocl.htm
MoDisco, “MoDisco Tool- Java Abstract Syntax Discovery Tool,” http://www.eclipse.org/gmt/modisco/toolBox/Java AbstractSyntax/
Object Management Group, “MOF 2.0/XMI Mapping Specification, V2.1.1,” http://www.omg.org/technology/documents/ formal/xmi.htm
Eclipse, “OCL for EMF,” http://www.eclipseplugincentral.com/Web_Links-index-req-viewlink-cid-200.html#, updated 2004
Eclipse, “Eclipse Modeling Framework Project,” http://www.eclipse.org/modeling/emf/?projectemf
E. van Emden and L.Moonen, “Java Quality Assurance by Detecting Code Smells,” In Proc. 9th Working Conference on Reverse Engineering IEEE Computer Society Press, October, 2002
R.C. Holt, “Structural Manipulations of Software Architecture using Tarski Relational Algebra,” In Proc. 5th Working Conference on Reverse Engineering (WCRE'98), pp.210-219, 1998
Narbor C. Mendonca, Paulo Henrique M. Maia, Leonardo A. Fonesca, Rossana M.C. Andrade, “RefaX : A Refactoring Framework Based on XML,” Proceedings of the 20th IEEE International Conference on Software Maintenamce (ICSM'04), 2004
Mammas, E. and Kontogiannis, C., “Towards Portable Source Code Representation using XML,” in Proc. of the 7th Working Conference on Reverse Engineering (WCRE, 00), Brisbane, Australia, pp.172-180, November, 2000
W3C, “XQuery 1.0 : An XML Query Language,” W3C Recommendation Draft 12 November 2003, Available at http://www.w3c.org/TR/xquery/, 2003
Roberts, D.B, “Practical Analysis for Refactoring,” Ph.D. Thesis, Unversity of Illinois at Urbana-Chanpaign, 1999
Mel O Cinneide, Automated Application of Design Patterns : A Refactoring Approach, Department of Computer Science, Trinity College Dublin, October, 2000
Raul Marticorena, Carlos Lopez, Yania Crespo, Francisco Javier Perez, “Reuse based Refactoring Tools,” Proceedings of 1st Workshop Refactorign Tools(WRT'07), pp.21-22, July, 2007

저자의 다른 논문 :

표제어: PCR

동의어: Packet Collision Rate

용어 설명 출처 목록 (6)

용어 설명: PCR은 세균 특이성이 있는 primer를 이용하여 적은 수의 세균이 있을지라도 쉽게 검출할 수 있는 유용한 방법이며, 이를 이용하여 구강 내 치면세균막이나 타액에서 직접 세균을 검출할 수 있게 되었다[8].

내보내기 구분	파일저장 인쇄 메일전송
구성항목	기본정보 상세정보 관리번호, 논문명, 저널/프로시딩명, 저자 , 발행년, 권, 호, 시작페이지, 끝페이지, 발행기관 관리번호, 논문명, 대등논문명, 저자 , 저널/프로시딩명, 발행기관, 발행년, 발행언어, 권, 호, 시작페이지, 끝페이지, ISBN, ISSN, 주제분야, 키워드, 초록(한글), 초록(영문), 저자(소속기관)
저장형식	Text(ASCII format) Excel format RefWorks Direct Export RIS format (for Reference Manager, ProCite, EndNote), Scholar's Aids, Mendeley
메일정보	받는사람 (필수) @ 보내는사람 (선택) @ 제목 내용 KISTI 검색결과 이메일 서비스
안내	총 건의 자료가 검색되었습니다. 다운받으실 자료의 인덱스를 입력하세요. (1-10,000) 검색결과의 순서대로 최대 10,000건 까지 다운로드가 가능합니다. 데이타가 많을 경우 속도가 느려질 수 있습니다.(최대 2~3분 소요) 다운로드 파일은 UTF-8 형태로 저장됩니다. 파일의 내용이 제대로 보이지 않을실 때는 웹브라우저 상단의 보기 -> 인코딩 -> 자동선택 여부를 확인하십시오. ~ Text(ASCII format) Excel format

연합인증