Java Reflection

Explained Simply

CiaranMcHale.com —

D. Acknowledgements Ciaran McHale’s employer. WHETHER IN AN ACTION OF CONTRACT. to any person obtaining a copy of this training course and associated documentation files (the "Training Course"). code generation.iona. and/or sell copies of the Training Course. THE TRAINING COURSE IS PROVIDED "AS IS".CiaranMcHale. such as multi-threading. TORT OR OTHERWISE. You can email him at Ciaran@CiaranMcHale.com. and to permit persons to whom the Training Course is furnished to do so. distribute. About the Author Ciaran McHale has a Ph. publish. including without limitation the rights to use.com. . INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY. modify. distributed middleware.com) since 1995. He has been working for IONA Technologies (www. OUT OF OR IN CONNECTION WITH THE TRAINING COURSE OR THE USE OR OTHER DEALINGS IN THE TRAINING COURSE. You can find details of some of his work at his personal web site: www. DAMAGES OR OTHER LIABILITY. where he is a principal consultant. IONA Technologies (www. subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Training Course. copy.Copyright License Copyright © 2008 Ciaran McHale Permission is hereby granted. sublicense. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM. EXPRESS OR IMPLIED. to deal in the Training Course without restriction. and writing training courses. configuration-file parsers. WITHOUT WARRANTY OF ANY KIND. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. His primary talent is the ability to digest complex ideas and reexplain them in simpler ways.com) generously gave permission for this training material to be released under the stated open-source license. in computer science from Trinity College Dublin. ARISING FROM. merge. free of charge. He applies this talent to subjects that stir his passion.iona.

Dynamic Proxies 3. Example Uses of Java Reflection . Introduction to Java Reflection 2.Table of Contents 1.

.

reflect. many people find reflection difficult at first - Many such features are not complex People just assume they are because they never read that part of the manual Reflection is one “advanced” issue that is not complex n It is an unusual way of programming But it becomes much easier once you “get it” Reflection seems natural to people who have written compilers (a parse tree is conceptually similar to metadata in reflection) A lot of reflection-based programming uses recursion 6 Introduction to Java Reflection 5 Introduction to Java Reflection Accessing metadata n Java stores metadata in classes - 2. Object obj = . WHETHER IN AN ACTION OF CONTRACT. free of charge. WITHOUT WARRANTY OF ANY KIND.forName(“java. Metadata - Metadata for a class: Metadata for a constructor: Metadata for a field: Metadata for a method: java. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT..Properties”).reflect. OUT OF OR IN CONNECTION WITH THE TRAINING COURSE OR THE USE OR OTHER DEALINGS IN THE TRAINING COURSE. distribute.Method n Two ways to access a Class object for a class: Class c1 = Class. Introduction Reflection is infrastructure enabling a program can see and manipulate itself It consists of metadata plus operations to manipulate the metadata n Meta means self-referential - So metadata is data (information) about oneself 3 Introduction to Java Reflection 4 Widespread ignorance of Java reflection n Is reflection difficult? n Typical way a developer learns Java: - When learning to program: - Buys a large book on Java Starts reading it Stops reading about half-way through due to project deadlines Starts coding (to meet deadlines) with what he has learned so far Never finds the time to read the rest of the book First learn iterative programming with if-then-else.Class java. 1 Introduction to Java Reflection Java Reflection Explained Simply Permission is hereby granted. and/or sell copies of the Training Course. including without limitation the rights to use.Field java.Constructor java. subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Training Course. DAMAGES OR OTHER LIABILITY.com 1 Introduction to Java Reflection 2 What is reflection? n When you look in a mirror: - You can see your reflection You can act on what you see. straighten your tie n In computer programming: - 1. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM. modify. for example. THE TRAINING COURSE IS PROVIDED "AS IS". sublicense.lang.util. ARISING FROM. CiaranMcHale. to any person obtaining a copy of this training course and associated documentation files (the “Training Course"). to deal in the Training Course without restriction. n Reflection classes are inter-dependent - Examples are shown on the next slide 7 Introduction to Java Reflection 8 . while-loop.lang.lang.getClass().. copy. … Later. Class c2 = obj. publish.lang. and to permit persons to whom the Training Course is furnished to do so. EXPRESS OR IMPLIED. TORT OR OTHERWISE. merge..Chapter 1: Introduction to Java Reflection License Copyright © 2008 Ciaran McHale.reflect. INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY. learn recursive programming n Most people find recursion difficult at first - Because it is an unusual way of programming But it becomes much easier once you “get it” n Result is widespread ignorance of many “advanced” Java features: - n Likewise.

D à double. Class c2 = boolean. Eclipse. Default Default Class c = Class. // only for arrays .newInstance(Object[] parameters) abstract class PluginManager { public static Plugin load(String name) throws Exception { String className = props.class..getConstructor( new Class[]{String.forName(“[Ljava. Class getReturnType().class”. } class Method { Class[] getParameterTypes(). Class c = Class. “y”}). public boolean isPrimitive().). .getReturnType() Method.forName() - B à byte... } } . Class c = Class..getConstructor(Class[] parameterTypes) Then call Constructor..forName(className)...create(). // byte[][] Class. S à short..).. } Introduction to Java Reflection 9 n Encoding scheme used by Class. Plugin obj = PluginManager. obj. } 3. return (Plugin)cons.Properties”). } . Use Class. } } ..).FooImpl”). public boolean isInterface(). J à long.forName(“[B”).newInstance() to call the default constructor Example: This technique is used in CORBA: - abstract class Foo { public static Foo create() throws Exception { Name of Name of String className = System.forName(“[[B”)..class}). Calling constructors Introduction to Java Reflection 11 12 Invoking a default constructor n Invoking a default constructor (cont’) n Use Class..Chapter 1: Introduction to Java Reflection Examples of inter-relatedness of reflection classes class Class { Constructor[] Field Field[] Method[] . Introduction to Java Reflection 15 Introduction to Java Reflection 16 . } getConstructors(). } abstract class PluginManager { public static Plugin load(String name) throws Exception { String className = props. Introduction to Java Reflection 13 CORBA is an RPC (remote procedure call) standard There are many competing implementations of CORBA Factory operation is called ORB..... String. abstract void op2(.newInstance(). public Class getComponentType().getProperty(name).getProperty(name).class.op1(.newInstance( new Object[]{“x”. getDeclaredMethods().class. // byte[] Class.example. Z à boolean Use as many “[”s as there are dimensions in the array Introduction to Java Reflection 10 Miscellaneous Class methods n Here are some useful methods defined in Class class Class { public String getName().getReturnType() Use Class.class. Class c3 = void.newInstance(). getDeclaredFields().).. n Might be returned by Might be returned by Method... . Plugin obj = PluginManager.load(“.implementation. return (Plugin)c.getProperty( property property “foo.init() A system property specifies which implementation of CORBA is used n A CORBA application can be written in a portable way - Specify the implementation you want to use via a system property (pass –D<name>=<value> command-line option to the Java interpreter) n Same technique is used for J2EE: - J2EE is a collection of specifications There are many competing implementations Use a system property to specify which implementation you are using Introduction to Java Reflection 14 A plug-in architecture n Invoking a non-default constructor n Use a properties file to store a mapping for plugin name à class name - Slightly more complex than invoking the default constructor: - Many tools support plugins: Ant. C à char... getDeclaredField(String name).. value value return (Foo)c. … abstract class Plugin { abstract void op1(. // byte Class. I à int. abstract void op1(.myproject..forName(className). // fully-qualified name public boolean isArray().load(“. } abstract void op1(..forName(className). F à float. class Field { Class getType().”)..util.. Constructor cons = c. Foo obj = Foo. n 2 Metadata for primitive types and arrays Java associates a Class instance with each primitive type: Class c1 = int. Lclass-name à class-name[]. “com..”)..forName() to access the Class object for an array Class Class Class Class c4 c5 c6 c7 = = = = byte.class.). Maven.

. . getFields(). lookup a public or non-public method declared in the specified class A better name A better name would have been would have been getPublicMethod() getPublicMethod() class Class { public Method getMethod(String name.getSuperclass(). public Method getDeclaredMethod(String name.lang. } Introduction to Java Reflection 21 5.Integer 4. Field f = c. } Introduction to Java Reflection 19 Introduction to Java Reflection 20 Finding an inherited method n This code searches up a class hierarchy for a method - Works for both public and non-public methods Method findMethod(Class cls..invoke(Object target.lang. Class c = obj.lang. Class c = obj.. Fields 22 Accessing a field n Looking up fields n There are two ways to access a field: - The API for looking up fields is fragmented: - By invoking get.getMethod(“doWork”. Class[] parameterTypes). Class[] paramTypes) { Method method = null..getField(“firstName”). Class[] parameterTypes). } getField(String name). Object result= m..invoke(obj.“y”}). Introduction to Java Reflection 23 Introduction to Java Reflection 24 .getClass().class}). Object[] parameters) Object obj = . while (cls != null) { try { method = cls..get(obj).set(obj. getDeclaredField(String name).. Class[]parameterTypes) Then call Method. f.lang. } } return method. à à à à java. You can lookup a public method in a class or its ancestor classes Or. Object value = f. } catch (NoSuchMethodException ex) { cls = cls..and set-style methods (if the class defines them) By using the code shown below Object obj = . paramTypes). lookup a public or non-public field declared in the specified class A better name A better name would have been would have been getPublicField() getPublicField() class Class { public Field public Field[] public Field public Field[] . break. getDeclaredFields(). Method m = c.getDeclaredMethod(methodName. public Method[] getMethods(). String methodName.getMethod(String name.Byte java.. “John”).. new Object[]{“x”.Boolean java. new Class[]{String. String. You can lookup a public field in a class or its ancestor classes Or.Chapter 1: Introduction to Java Reflection Passing primitive types as parameters n 3 If you want to pass a primitive type as a parameter: - Wrap the primitive value in an object wrapper Then use the object wrapper as the parameter n Object wrappers for primitive types: - boolean byte char int . public Method[] getDeclaredMethods().getClass().class.Character java. Methods Introduction to Java Reflection 17 18 Invoking a method n Looking up methods n Broadly similar to invoking a non-default constructor: - The API for looking up methods is fragmented: - Use Class.

boolean flag). synchronized.get(obj). isFinal(int modifier).isPublic(field. transient and volatile Both Field and Method define the following methods (inherited from java. String fieldName) { Field field = null.lang. public. isNative(int modifier). Forman and Nate Forman It is concise and easy to understand 7.getSuperclass(). } Hibernate uses this technique Hibernate uses this technique Object obj = field. } 6. static.AccessibleObject): boolean isAccessible(). so it can serialize non-public so it can serialize non-public fields of an object to a database fields of an object to a database 28 Introduction to Java Reflection 27 Introduction to Java Reflection Further reading n There are very few books that discuss Java reflection - An excellent one is Java Reflection in Action by Ira R. final.Modifier: static static static static .. Further reading and summary n Main other source of information is Javadoc documentation 29 Introduction to Java Reflection 30 Summary n This chapter has introduced the basics of Java reflection: - Metadata provides information about a program Methods on the metadata enable a program to examine itself and take actions n Reflection is an unusual way to program: - Its “meta” nature can cause confusion at first It is simple to use once you know how n The next chapter looks at a reflection feature called dynamic proxies Introduction to Java Reflection 31 .lang. void setAccessible(boolean flag). boolean boolean boolean boolean isAbstract(int modifier). strictfp. Modifiers Introduction to Java Reflection 25 26 Java modifiers n Accessing non-public fields and methods n Java defines 11 modifiers: - abstract. } } return field. protected. method or field: - Set of modifiers is represented as bit-fields in an integer Access set of modifiers by calling int getModifiers() n n Useful static methods on java.reflect.getDeclaredField(fieldName). while (cls != null) { try { field = cls.setAccessible(true). private. n Better terminology might have been “SuppressSecurityChecks” instead of “Accessible” Example of use: if (!Modifier.reflect. } catch (NoSuchFieldException ex) { cls = cls. break. native.. n Some of the modifiers can be applied to a class. static void setAccessible(AccessibleObject[] array. isPrivate(int modifier).Chapter 1: Introduction to Java Reflection Finding an inherited field n 4 This code searches up a class hierarchy for a field - Works for both public and non-public fields Field findField(Class cls.getModifiers()) { field.

.reflect package class Proxy { public static Object newProxyInstance( ClassLoader loader.getClassLoader() . THE TRAINING COURSE IS PROVIDED "AS IS".newInstance().targetObj. to deal in the Training Course without restriction. InvocationHandler h) throws . new Handler(target)). to any person obtaining a copy of this training course and associated documentation files (the “Training Course"). } catch(InvocationTargetException ex) { . OUT OF OR IN CONNECTION WITH THE TRAINING COURSE OR THE USE OR OTHER DEALINGS IN THE TRAINING COURSE.invoke() to delegate to the target object . distribute.3 introduced dynamic proxies - Example: if you ask a friend to vote on your behalf then you are “voting by proxy” The API is defined in the java. 5 Dynamic Proxies Java Reflection Explained Simply Permission is hereby granted.newProxyInstance() method: - Write a class that implements InvocationHandler Your implementation of invoke() should: .. and/or sell copies of the Training Course. WHETHER IN AN ACTION OF CONTRACT.targetObj.getClass().getClass. Object[] args) throws Throwable { Object result = null.lang. // added-value code result = m.. ARISING FROM. // continued on the next slide Dynamic Proxies 7 Dynamic Proxies 8 .Each method puts parameters into Object[] and calls InvocationHandler. } . EXPRESS OR IMPLIED.getClass().newProxyInstance( target...getInterfaces().com 1 Dynamic Proxies 2 What is a proxy? n Dynamic proxies in Java n Dictionary definition: “a person authorized to act for another” - Java 1.invoke(target. Method m. a proxy is a delegation object (or process) Used in remote procedure call (RPC) mechanisms: - Client invokes on a (local) proxy object Proxy object sends request across the network to a server and waits for a reply Firewall prevents outgoing connections to port 80 So web browsers cannot connect to remote web sites directly Web browsers are configured to connect via the company’s proxy server Proxy server can be configured to disallow access to eBay.newInstance() to an interface implemented by the target object Dynamic Proxies 5 Dynamic Proxies 6 Sample code public class Handler implements InvocationHandler { private Object target.. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM.. } interface InvocationHandler { Object invoke(Object proxy. INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY.. // added-value code throw ex.getClass(). with the following parameters: .target = target. subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Training Course.. sublicense.Implements the specified interfaces . try { . merge. TORT OR OTHERWISE..getClassLoader(). // continued from the previous slide public static Object createProxy(Object target) { return Proxy. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.InvocationHandler object “wrapper” around the target object n Can use a dynamic proxy only if a class implements 1+ interfaces - n Step 3: - Use of interfaces is a good programming practice So this requirement is not a problem in practice Typecast the result of Proxy. publish. free of charge. DAMAGES OR OTHER LIABILITY. args). Class[] interfaces. . private Handler(Object target) { this. modify.Use Method.. and to permit persons to whom the Training Course is furnished to do so. CiaranMcHale. copy.getCause(). Object[] args) throws Throwable. … n Some companies set up a HTTP proxy server: - Dynamic Proxies 3 Dynamic Proxies 4 Steps required to create a dynamic proxy n How does this work? n Step 1: - The Proxy. Method m. } n n In computer terms. target. } The proxy parameter The proxy parameter is usually ignored is usually ignored Sample code (cont’) . } } public Object invoke(Object proxy.invoke() n Step 2: - Call Proxy. Amazon. WITHOUT WARRANTY OF ANY KIND.getInterfaces() . } return result. including without limitation the rights to use..Chapter 2: Dynamic Proxies License Copyright © 2008 Ciaran McHale.Provide some “added value” logic Uses runtime code generation techniques Generates a “hidden” class with a name of the form $Proxy<int> (Use of “$” prevents namespace pollution) Generated class: .

a proxy might “pretend” to be target object - Returns “test” values instead of delegating to a real object EasyMock (www.org) makes it easy to write tests in this way Dynamic Proxies 9 .Chapter 2: Dynamic Proxies Example uses for dynamic proxies n 6 Added-value code might: - Enforce security checks Begin and commit or rollback a transaction Use reflection & recursion to print details of all parameters (for debugging) n In a testing system.easymock.

”/> <property name=“lib.”/> <target name=“do-everything”> <mkdir dir=“.....5) Reflection is used to find methods with the appropriate annotation Example Uses of Java Reflection 7 Example Uses of Java Reflection 8 .dir” value=“.”/> <foo .. subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Training Course..> <bean id=“employee1” class=“com.. …) - A properties file provides a mapping for task-name à class-that-implements-task n Users can use taskdef to tell Ant about user-written tasks - See example on the next slide 3 Example Uses of Java Reflection 4 Example Ant build file <?xml version=“1.. TORT OR OTHERWISE. copy.Employee”> <property name=“firstName” value=“John”/> <property name=“lastName” value=“Smith”/> <property name=“manager” ref=“manager”/> </bean> <bean id=“manager” class=“com.. 7 Example Uses of Java Reflection Java Reflection Explained Simply Permission is hereby granted.”/> <mkdir dir=“.com 1 Example Uses of Java Reflection 2 Ant n n Ant reads build (compilation) instructions from an XML file Ant is hard-coded to know how to process top-level elements - property.Foo”/> </project> n - Auto-completion in a text editor Some Java editors and IDEs provide auto-completion Example: you type “someObj. ARISING FROM. OUT OF OR IN CONNECTION WITH THE TRAINING COURSE OR THE USE OR OTHER DEALINGS IN THE TRAINING COURSE.. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM.example.. WITHOUT WARRANTY OF ANY KIND. free of charge. merge. sublicense.Employee”> <property name=“firstName” value=“John”/> <property name=“lastName” value=“Smith”/> <property name=“manager” ref=“manager”/> </bean> . </beans> n Test methods are identified by an annotation (Annotations were introduced in Java 1. target..> <property name=“src.xyz.” basedir=“. taskdef and so on 1. INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY. including without limitation the rights to use.tools.0”?> <project name=“example build file” .” destdir=“. to deal in the Training Course without restriction. and to permit persons to whom the Training Course is furnished to do so.. to any person obtaining a copy of this training course and associated documentation files (the “Training Course"). distribute.. publish.. THE TRAINING COURSE IS PROVIDED "AS IS".. WHETHER IN AN ACTION OF CONTRACT..dir” value=“.. and/or sell copies of the Training Course.xyz.0”?> <beans . mkdir.” and a pop-up menu lists fields and methods for the object’s type n The pop-up menu is populated by using Java reflection Example Uses of Java Reflection 5 Example Uses of Java Reflection 6 JUnit n Spring n JUnit 3 uses reflection to find methods whose names start with “test” The algorithm was changed in JUnit 4 - Below is an extract from a Spring configuration file: <?xml version=“1..”/> <property name=“build.... DAMAGES OR OTHER LIABILITY..Chapter 3: Example Uses of Java Reflection License Copyright © 2008 Ciaran McHale.” excludes=“. javac.” excludes=“. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.. modify..example.”/> <javac srcdir=“...”/> <jar jarfile=“..../> </target> <taskdef name=“foo” classname=“com. EXPRESS OR IMPLIED.example. CiaranMcHale. Basic uses of Java reflection n Each Ant task (used inside target elements) is a plug-in - See example Ant build file on the next slide for examples of tasks n Many task plug-ins are bundled with the Ant distribution (jar.dir” value=“.

class files as your parse tree Use reflection to navigate over this “parse tree” 11 - Example Uses of Java Reflection Example Uses of Java Reflection 12 Uses for runtime code generation n n Uses for Java bytecode manipulation n Runtime code generation is used… By JSP (Java Server Pages) - Compilers: - To generate servlets from .class file. optimize bytecode and rewrite the .Can use (non-standard) API to Sun Java compiler .Chapter 3: Example Uses of Java Reflection Spring (cont’) n 8 Spring uses reflection to create an object for each bean - The object’s type is specified by the class attribute n By default.class files Modify bytecode to insert “interception” code Generate proxies for classes or interfaces Spring uses this technique 14 n By IDEs and debuggers - Optimization: - To evaluate Java expressions entered by user n Code analysis: - n Code obfuscation: - n Aspect-oriented programming (AOP): - Example Uses of Java Reflection 13 Example Uses of Java Reflection Tools for bytecode manipulation n Example open-source projects for bytecode manipulation: - ASM (http://asm.org/) BCEL (http://jakarta.Provided in tools.codehaus.objectweb. use Class.Or can use Janino (an open-source.org) uses this technique Read a . the object is created with its default constructor - You can use constructor-arg elements (nested inside bean) to use a non-default constructor 2. such as Spring and Hibernate 3. Code generation and bytecode manipulation n After an object is constructed.sourceforge.setXxx() Spring can support primitive types and common Collection types The ref attribute refers to another bean identified by its id - Example Uses of Java Reflection 9 10 Code generators n Code generators (cont’) n Generated files Most compilers have the following architecture compiler parse tree Compile-time code generation in a project: - Use technique described on previous slide to generate code Then run Java compiler to compile generated code Use Ant to automate the code generation and compilation input file parser Back-end code generator n Runtime code generation: - n Java’s reflection metadata is conceptually similar to a parse tree You can build a Java code generation tool as follows: - Use techniques described on previous slide to generate code Then invoke a Java compiler from inside your application: .setXxx(value) .apache.net Finally. which is shipped with the Sun JDK .jsp files n Write a compiler for a scripting language and generate Java bytecode . embeddable. analyze bytecode and generate a report Mangle names of methods and fields in .net) n CGLIB (Code Generation LIBrary): - Built on top of BCEL Provides a higher-level API for generating dynamic proxies Used by other tools.Result: out-of-the-box integration between Java and the language Groovy (groovy.org/bcel/) SERP (serp. Summary Example Uses of Java Reflection 15 16 .class file.Hosted at www. each property is examined - Spring uses reflection to invoke obj.jar.Where Xxx is the capitalized name of property xxx Spring uses reflection to determine the type of the parameter passed to obj.janino.class file Read a .forName() to load the compiled code n Do not write a Java parser. Instead run the Java compiler Treat generated . Java compiler) .

Chapter 3: Example Uses of Java Reflection Summary n 9 A lot of tools use Java reflection: - - Plugins to extend functionality of an application (Ant) Auto-completion in Java editors and IDEs Use naming conventions of methods to infer semantics (JUnit test methods) Tie components together (Spring) Compile-time code generation Runtime code generation .Generate servlets from a markup language (JSP) Evaluate Java expressions entered interactively by a user Example Uses of Java Reflection 17 .Generate proxies .

Chapter 3: Example Uses of Java Reflection 10 .

Sign up to vote on this title
UsefulNot useful