{"id":27969,"date":"2020-06-03T08:00:38","date_gmt":"2020-06-03T08:00:38","guid":{"rendered":"https:\/\/blog.jetbrains.com\/idea\/?p=21994"},"modified":"2024-06-06T10:26:00","modified_gmt":"2024-06-06T09:26:00","slug":"code-formatting","status":"publish","type":"idea","link":"https:\/\/blog.jetbrains.com\/en\/idea\/2020\/06\/code-formatting","title":{"rendered":"How to Format Java Code"},"content":{"rendered":"

Just about every developer has an opinion on the formatting of Java code! With IntelliJ IDEA, your team can define its own standards and have the IDE apply them automatically so individual developers don\u2019t have to think about formatting their code as they work.<\/p>\n

<\/p>\n

Download IntelliJ IDEA<\/a><\/p>\n

While coding with IntelliJ IDEA, we don\u2019t need to manually format our code, as the IDE does it automatically. For example, if we press Enter<\/i> (Windows\/Linux) or \u23ce<\/i><\/b> (macOS), the caret goes into the correct place for us to start typing. The same is true if we use other shortcuts like Shift+Enter<\/i> (Windows\/Linux) or \u21e7\u23ce<\/i> (macOS) to move to the next line, or if we use code generation.<\/p>\n

\"Creating<\/p>\n

If we copy some code that is inconsistently formatted and paste it into the editor, IntelliJ IDEA will format the code according to the project\u2019s standards.<\/p>\n

Reformatting Code<\/h2>\n

However, if we do have code that doesn’t meet the project’s standards, we can ask IntelliJ IDEA to format it.<\/p>\n

    public void horriblyFormattedMethod  (){\n        System.out.println("First line");\n            System.out.println("Second line");\n          System.out.println("Third line");\n        for (int i = 0; i < 3; i++)\n        System.out.println("I have no idea where the indentation is supposed to be");\n    }\n<\/pre>\n
Highlight a specific piece of code, like the code above, and press Ctrl+Alt+L<\/i> (Windows\/Linux) or\u2325\u2318L<\/i> (macOS) to format just the highlighted code. Or we can use this same shortcut without selecting the code and the whole file will be reformatted.<\/p>\n
\"Automatically<\/p>\n
We can go to Preferences\/Settings<\/i> | Code Style<\/i> | Java<\/i> and set our standards. From there, we can also copy the default code style settings and save them with a useful name.<\/p>\n
\"Code<\/p>\n
If we want to specify that if<\/code> statements should always have curly braces, we go into Wrapping and Braces<\/i> and force if<\/code> statements to always have curly braces. The preview on the right shows what selecting this setting will do to the code, so we can experiment with these settings to see which one we want.<\/p>\n
\"Force<\/p>\n
If we save changes to the code style, IntelliJ IDEA will reformat it to the new style.<\/p>\n
There are a lot of code style settings to look through and change. There is a simpler way, if we have a section of code that we know needs reformatting differently.<\/p>\n
public void horriblyFormattedMethod() {\n    System.out.println("First line");\n    System.out.println("Second line");\n    System.out.println("Third line");\n    for (int i = 0; i < 3; i++)\n        System.out.println("I have no idea where the indentation is supposed to be");\n}<\/pre>\n
For example, if we want for<\/code> loops to also have curly braces, we can highlight a for<\/code> loop, press Alt+Enter<\/i> (Windows\/Linux) or \u2325\u23ce<\/i> (macOS), and select Adjust code style settings<\/i>. IntelliJ IDEA will display only the settings that apply to this bit of code.<\/p>\n
\"Adjust<\/p>\n
We can experiment with these settings and see the changes previewed live in our code. Under \u2018for()\u2019 statement<\/i> in the Wrapping and Braces<\/i> tab, we set Force braces<\/i> to Always<\/i> so IntelliJ IDEA will always insert curly braces around the body of our for<\/code> loops. When we save these changes, they will be saved to our current Code Style scheme.<\/p>\n
\"Force<\/p>\n
Often we don’t want to reformat the whole file. If we were working on a file with some inconsistently formatted code, but we’ve only changed a small part of it, running Reformat Code<\/em> might change parts of the file we haven’t touched. We could highlight the code we’ve changed and just reformat that, but that won’t work if our changes are scattered throughout the file.<\/p>\n
There’s a better way: we can use Ctrl+Alt+Shift+L<\/i> (Windows\/Linux) or \u2325\u21e7\u2318L<\/i> (macOS), to bring up the reformatting options. We can say we only want to format the lines of the file that have been changed, and leave everything else alone. Now when the file is formatted, it only changes the lines that we’ve touched and nothing else.<\/p>\n
\"Reformat<\/p>\n
Example: Formatting Java 8 Streams<\/h3>\n
Let’s walk through setting specific formatting for use with Java 8 Streams. We’ll change the settings so that Stream operations are always on a separate line, and they are lined up underneath each other.<\/p>\n
Let’s assume the current code style settings allow the chained method calls on the Streams API to stay on the same line, making an extremely long line of code.<\/p>\n
private int replaceWithMapToInt() {\n    int sum = integerStringMap.values().stream().filter(Objects::nonNull).flatMap(Collection::stream).filter(stringVal -> stringVal.contains("error")).mapToInt(String::length).sum();\n    return sum;\n}\n<\/pre>\n
Highlight the stream all and use Alt+Enter<\/i> (Windows\/Linux) or \u2325\u23ce<\/i> (macOS) to see which settings can be changed for this code. Under the Wrapping and Braces<\/i> tab, change the wrapping settings for Chained method calls<\/i> to Wrap always<\/i>. We can try out these different settings to see which combination we want, the changes are previewed in the editor.<\/p>\n
\"Adjust<\/p>\n
This is a good first step towards what we want, but we want the dots to all line up vertically. To do this, we need to go back into our code style settings Preferences\/Settings<\/i> | Code Style<\/i> | Java<\/i>.<\/p>\n
Go to the Wrapping and Braces<\/i> tab, and find Chained method calls<\/i>. This should already be set to Wrap always<\/i> since we just set that. We also need to tick Align when multiline<\/i>. The preview should show us this is what we wanted.<\/p>\n
\"Java<\/p>\n
Save this change to the code style settings, and then reformat the file – the stream call should be aligned the way we wanted.<\/p>\n
private int replaceWithMapToInt() {\n    int sum = integerStringMap.values()\n                                .stream()\n                                .filter(Objects::nonNull)\n                                .flatMap(Collection::stream)\n                                .filter(stringVal -> stringVal.contains("error"))\n                                .mapToInt(String::length)\n                                .sum();\n    return sum;\n}\n<\/pre>\n
Using EditorConfig<\/h2>\n
These formatting settings are stored in a settings file in the project\u2019s .idea<\/code> folder. IntelliJ IDEA also supports using an EditorConfig<\/code> file to define the code style. You can create a new EditorConfig<\/code> file by right-clicking on the .idea<\/code> folder and then selecting New<\/i> | New EditorConfig File<\/i>. This will be our root, add the standard EditorConfig properties and IntelliJ IDEA-specific settings for Java code.<\/p>\n
\"New<\/p>\n
IntelliJ IDEA populates this file with all the settings that we’ve already defined for our code style. The properties are split into those which apply to all files, and those which apply only to Java files. Anything with an ij<\/code> prefix is a setting specific to IntelliJ IDEA. If we look through all these settings, we can see the ones we’ve just defined for Java 8 streams: that we want chained method calls to be aligned; that we want chained method calls to be wrapped with one operation on each line.<\/p>\n
Copy the Stream method call code:<\/p>\n
public class Foo {\n    public int[] X = new int[]{1, 3, 5, 7, 9, 11};\n\t\n\tint count = integerStringMap.values()\n                                .stream()\n                                .filter(Objects::nonNull)\n                                .flatMap(Collection::stream)\n                                .filter(stringVal -> stringVal.contains("error"))\n                                .mapToInt(String::length)\n                                .sum();\n    return sum;\n}\n<\/pre>\n
and paste it into the preview panel for the editor config. Then we can see what happens to our code when we make changes to the EditorConfig properties.<\/p>\n
Turn off the chained method calls wrapping by setting ij_java_method_call_chain_wrap<\/code> to off<\/code> (note that IntelliJ IDEA gives us code completion here).<\/p>\n
\"EditorConfig<\/p>\n
Set ij_java_keep_line_breaks<\/code> to false<\/code>. The preview shows us the Stream call is put back onto a single line.<\/p>\n
If we go back to our code and reformat it, we can see IntelliJ IDEA uses the new EditorConfig settings to format the changed lines in the file. Note that our EditorConfig settings are used instead of the settings we defined in our Java Code Style<\/i> preferences, which still has our old settings for Chained Method Calls<\/i>. If we look at the Code Style<\/i> Settings, we can see that EditorConfig support is enabled, and that this setting warns us the EditorConfig<\/code> file settings may override the IDE settings.<\/p>\n
\"Java<\/p>\n
One of the advantages of using an EditorConfig<\/code> file is that we can define a file for each directory. This is useful if we have different code settings for test code and production code, or if a legacy part of the code base has a different style.<\/p>\n
Rearranging Code<\/h2>\n
We’ve seen how to reformat our code, how to change the settings for code style, including using an EditorConfig<\/code> file to store the settings, and how reformatting can even do small code changes like adding braces. Let’s look now at one of the options mentioned in the reformat file settings \u2013 Rearrange Code.<\/p>\n
Open a class with a lot of methods and fields declared in it, like this one<\/a>.<\/p>\n
public class RearrangeCode {\n    private int id;\n\n    public int getId() {\n        return id;\n    }\n\n    public void setId(int id) {\n        this.id = id;\n    }\n\n    private String firstName;\n\n    public String getFirstName() {\n        return firstName;\n    }\n\n    @Override\n    public String toString() {\n        return "RearrangeCode{" +\n                "id=" + id +\n                ", firstName='" + firstName + '\\'' +\n                ", lastName='" + lastName + '\\'' +\n                ", email='" + email + '\\'' +\n                ", ordersById=" + ordersById +\n                '}';\n    }\n\n    public void setFirstName(String firstName) {\n        this.firstName = firstName;\n    }\n\n    private void privateHelperMethod() {\n        \/\/ does something in here\n    }\n\n    private String lastName;\n\n    public String getLastName() {\n        return lastName;\n    }\n\n    public void setLastName(String lastName) {\n        this.lastName = lastName;\n    }\n\n    private String email;\n\n    public String getEmail() {\n        return email;\n    }\n\n    public void setEmail(String email) {\n        this.email = email;\n    }\n\n    @Override\n    public boolean equals(Object o) {\n        if (this == o) return true;\n        if (o == null || getClass() != o.getClass()) return false;\n        RearrangeCode that = (RearrangeCode) o;\n        return id == that.id &&\n                Objects.equals(firstName, that.firstName) &&\n                Objects.equals(lastName, that.lastName) &&\n                Objects.equals(email, that.email) &&\n                Objects.equals(ordersById, that.ordersById);\n    }\n\n    @Override\n    public int hashCode() {\n        return Objects.hash(id, firstName, lastName, email, ordersById);\n    }\n\n    private Collection<Order> ordersById;\n\n    public Collection<Order> getOrdersById() {\n        return ordersById;\n    }\n\n    public void setOrdersById(Collection<Order> ordersById) {\n        this.ordersById = ordersById;\n    }\n}<\/pre>\n
This class has fields, setters, getters, and other standard methods, all scattered throughout the file. Use Find Action<\/i> (Shift+Ctrl+A<\/i> or \u21e7\u2318A<\/i>), and start typing “rearrange” to find the Rearrange Code<\/em> action. Select this and IntelliJ IDEA will reorder the code of this class according to the settings for the project.<\/p>\n
\"Rearrange
\nView via Local History<\/em><\/p>\n
We can see all the fields are placed at the top of the file and the getters and setters for a field are placed next to each other. This definitely helps to see at a glance what’s included in the state of an instance of this class. However, we might want to go further in organising the code in a class. For example, we might want to put private methods to the bottom of the class, underneath all the public ones.<\/p>\n
Open up Preferences\/Settings<\/i>. Once again, we need to be in Code Style<\/i> | Java<\/i>, but this time we need to look under the Arrangement<\/i> tab. There are some standard rules which can be turned on or off, like keeping the getters and setters together. The bottom section shows all the rules for arranging the file. By default, fields will be ordered according to the modifiers that apply to them, and they’ll always be at the top of the file. Initialisers and constructors will come after the fields, methods come after that, and if there are any inner enums, interfaces or classes, they’ll be put at the bottom of the file.<\/p>\n
Let\u2019s make the existing method rule apply to public methods and then add a new rule for private ones. These rules will cause the public methods to appear above the private ones.<\/p>\n
\"Arrange<\/p>\n
We could use Find Action<\/i> (Shift+Ctrl+A<\/i> or \u21e7\u2318A<\/i>) again to rearrange the file, or reformat the file and tick the rearrange code option. But we can also use Search Everywhere<\/i> (Shift+Shift<\/i> or \u21e7\u21e7<\/i>) and type “rearrange”. Once we’ve called the rearrange code action, we’ll see that our private method has been moved to the bottom of the file, underneath all the public methods.<\/p>\n
\"Code<\/p>\n
IntelliJ IDEA offers a lot of automation and configuration features that let us define exactly how our files should be formatted, and it even lets us specify the order in which things appear in our code files. This lets us customize a consistent style for our project and makes it easier to write code that\u2019s consistent with that of the rest of our team.<\/p>\n