To compile Protocol Buffers with Maven, add the Protocol Buffers Maven Plugin to your pom.xml, make protoc available, add the matching Java runtime dependency, and run the plugin’s compile goal. Put application schemas in src/main/proto; add test-compile only if your tests have their own .proto files.
Configure Maven to generate Java from your schemas
The Maven Protocol Buffers Plugin runs protoc and generates source code during the build. Its documented default locations are src/main/proto for application schemas and src/test/proto for test schemas. Subdirectories beneath those paths can mirror package-like directory structures used for imports. See the plugin usage guide.
Add the plugin and runtime dependency to your project. The version fields below are deliberately not filled in: the usage guide’s examples use plugin version 0.6.1 and protobuf-java version 3.4.0, but those are historical examples, not current version recommendations. Check Maven Central for released versions and select compatible compiler and runtime versions before using this configuration.
<build>
<plugins>
<plugin>
<groupId>org.xolstice.maven.plugins</groupId>
<artifactId>protobuf-maven-plugin</artifactId>
<version>REPLACE_WITH_VERIFIED_RELEASE</version>
<configuration>
<!-- Optional: set this if protoc is not on PATH. -->
<protocExecutable>/path/to/protoc</protocExecutable>
</configuration>
<executions>
<execution>
<goals>
<goal>compile</goal>
<!-- Add test-compile only if src/test/proto contains schemas. -->
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<dependencies>
<dependency>
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java</artifactId>
<version>REPLACE_WITH_COMPATIBLE_VERSION</version>
</dependency>
</dependencies>Replace both version markers with actual compatible versions; they are explanatory text, not valid Maven versions. The plugin documentation recommends using the same version for protoc and protobuf-java where possible. The plugin itself is separate from Maven’s default lifecycle, so its execution must be declared. The compile goal defaults to the generate-sources phase, so an explicit <phase> element is generally unnecessary.
Outdated Drivers Are Slowing You Down
One free scan finds every outdated or missing driver and matches the right update for your exact hardware.Free scan · exact hardware matchPC Slower Than It Used to Be?
A free scan shows the junk files, broken settings and background clutter dragging Windows down - then fixes them in one click.Free scan · Windows 10 & 11#1 Best Overall
Make the Protocol Buffers compiler available
The plugin invokes protoc. Choose one provisioning method and ensure the compiler is available wherever the Maven build runs, including CI agents:
- Use
PATH: install or otherwise provisionprotocso the build environment can find it. - Set
protocExecutable: configure the plugin with the executable’s path, as in the XML example. - Use Maven toolchains: the plugin guide documents a toolchain approach for selecting the compiler.
The plugin API lists compile as generating main sources and using dependency artifacts that contain .proto files as import paths. It also adds proto files as project resources. Goal details are listed in the compile goal API reference.
Run the build and generate test schemas only when needed
With the plugin execution declared, run your normal Maven build, such as mvn compile, to invoke the bound protobuf:compile goal during generate-sources. To invoke the goal directly, use mvn protobuf:compile.
If test code defines schemas under src/test/proto, add test-compile to the execution’s goals. That separate goal generates test sources; it is unnecessary when tests consume only application-generated classes.
The Tool Desk
Outbyte PC Repair FREERepair Windows errors before they cause bigger problemsFix Now →Outbyte Driver Updater FREEScan for outdated or missing drivers - takes under a minuteDriver Scan →Choose another output language or a custom generator when appropriate
The plugin documentation lists goals for generating C++, C#, JavaScript, Python, and other outputs, as well as custom generators. Use the goal that matches the project’s intended language rather than assuming the Java configuration produces every target. The available goals and their behavior are listed in the plugin API index.
For a custom protoc generator, the plugin supports Java plugins resolved as Maven artifacts and native plugins. Use compile-custom for main schemas and test-compile-custom for test schemas; Java plugin configuration identifies artifact coordinates and the plugin’s main class. Check the generator’s own current version and compatibility. See the custom generator example.
Troubleshoot common build problems
- Maven cannot find
protoc: verify it is on the build environment’sPATH, setprotocExecutable, or configure the documented Maven toolchain. - Generated Java does not compile: check compatibility between the
protoccompiler andprotobuf-javaruntime. The usage guide recommends matching their versions where possible. - The command line is too long: for
protoc3.5.0 or newer, the guide documents the plugin’suseArgumentFileoption. With older compiler versions, split compilation into smaller chunks, for example by using separate Maven modules. - The plugin keeps regenerating unchanged output: review the documented
checkStalenesssetting. Builds on NFS may also need an appropriatestaleMillisvalue. - Test schemas are not generated: add the separate
test-compilegoal to the plugin execution.
Because version availability can change, distinguish a released artifact from a snapshot when choosing the plugin version. The usage and custom-generator pages are dated 2018; Sonatype Central lists 0.6.1, while the repository’s master POM shows 0.7.0-SNAPSHOT. A snapshot POM does not establish a newer stable release, so verify the release in Maven Central before pinning it. No build result is implied by this configuration.
Quick Recap
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
Quick wins for a faster PC:
Fix the driver behind crashes, sound loss and screen glitchesFind Drivers →Clear out junk files and repair common Windows errorsFree Scan →
