Why should I use the keyword "final" on a method parameter in Java?

I can't understand where the final keyword is really handy when it is used on method parameters.

If we exclude the usage of anonymous classes, readability and intent declaration then it seems almost worthless to me.

Enforcing that some data remains constant is not as strong as it seems.

  • If the parameter is a primitive then it will have no effect since the parameter is passed to the method as a value and changing it will have no effect outside the scope.

  • If we are passing a parameter by reference, then the reference itself is a local variable and if the reference is changed from within the method, that would not have any effect from outside of the method scope.

  • Consider the simple test example below. This test passes although the method changed the value of the reference given to it, it has no effect.

    public void testNullify() {
        Collection<Integer> c  = new ArrayList<Integer>();      
        nullify(c);
        assertNotNull(c);       
        final Collection<Integer> c1 = c;
        assertTrue(c1.equals(c));
        change(c);
        assertTrue(c1.equals(c));
    }
    
    private void change(Collection<Integer> c) {
        c = new ArrayList<Integer>();
    }
    
    public void nullify(Collection<?> t) {
        t = null;
    }
    

    Sometimes its nice to be explicit(for readability) that the variable doesn't change. Here's a simple example where using final can save some possible headaches

    public void setTest(String test) {
        test = test;
    }
    

    if you forget the 'this' keyword on a setter the variable you want to set doesn't get set. However if you used the final keyword on the parameter then the bug would be caught at compile time.


    Stop a Variable's Reassignment

    While these answers are intellectually interesting, I've not read the short simple answer:

    Use the keyword final when you want the compiler to prevent a variable from being re-assigned to a different object.

    Whether the variable is a static variable, member variable, local variable, or argument/parameter variable, the effect is entirely the same.

    Example

    Let's see the effect in action.

    Consider this simple method, where the two variables (arg and x) can both be re-assigned different objects.

    // Example use of this method: 
    //   this.doSomething( "tiger" );
    void doSomething( String arg ) {
      String x = arg;   // Both variables now point to the same String object.
      x = "elephant";   // This variable now points to a different String object.
      arg = "giraffe";  // Ditto. Now neither variable points to the original passed String.
    }
    

    Mark the local variable as final. This results in a compiler error.

    void doSomething( String arg ) {
      final String x = arg;  // Mark variable as 'final'.
      x = "elephant";  // Compiler error: The final local variable x cannot be assigned. 
      arg = "giraffe";  
    }
    

    Instead, let's mark the parameter variable as final. This too results in a compiler error.

    void doSomething( final String arg ) {  // Mark argument as 'final'.
      String x = arg;   
      x = "elephant"; 
      arg = "giraffe";  // Compiler error: The passed argument variable arg cannot be re-assigned to another object.
    }
    

    Moral of the story:

    If you want to ensure a variable always points to the same object, mark the variable final.

    Never Reassign Arguments

    As good programming practice (in any language), you should never re-assign a parameter/argument variable to an object other than the object passed by the calling method. In the examples above, one should never write the line arg = . Since humans make mistakes, and programmers are human, let's ask the compiler to assist us. Mark every parameter/argument variable as 'final' so that the compiler may find and flag any such re-assignments.

    In Retrospect

    As noted in other answers… Given Java's original design goal of helping programmers to avoid dumb mistakes such as reading past the end of an array, Java should have been designed to automatically enforce all parameter/argument variables as 'final'. In other words, Arguments should not be variables. But hindsight is 20/20 vision, and the Java designers had their hands full at the time.

    Another case added for the completeness

    public class MyClass {
        private int x;
        //getters and setters
    }
    
    void doSomething( final MyClass arg ) {  // Mark argument as 'final'.
    
       arg =  new MyClass();  // Compiler error: The passed argument variable arg  cannot be re-assigned to another object.
    
       arg.setX(20); // allowed
      // We can re-assign properties of argument which is marked as final
     }
    

    Yes, excluding anonymous classes, readability and intent declaration it's almost worthless. Are those three things worthless though?

    Personally I tend not to use final for local variables and parameters unless I'm using the variable in an anonymous inner class, but I can certainly see the point of those who want to make it clear that the parameter value itself won't change (even if the object it refers to changes its contents). For those who find that adds to readability, I think it's an entirely reasonable thing to do.

    Your point would be more important if anyone were actually claiming that it did keep data constant in a way that it doesn't - but I can't remember seeing any such claims. Are you suggesting there's a significant body of developers suggesting that final has more effect than it really does?

    EDIT: I should really have summed all of this up with a Monty Python reference; the question seems somewhat similar to asking "What have the Romans ever done for us?"

    链接地址: http://www.djcxy.com/p/3540.html

    上一篇: 在现代Python中声明自定义异常的正确方法是什么?

    下一篇: 为什么我应该在Java的方法参数中使用关键字“final”?