Intégrer le Protocole de Tampons dans Maven2 construire

Je suis en train d'expérimenter avec des Tampons de Protocole en vigueur, de façon équitable à la vanille Maven 2 du projet. Actuellement, j'invoque un script shell à chaque fois que j'ai besoin de mettre à jour mon généré sources. C'est évidemment un soucis, que je voudrais les sources pour être généré automatiquement avant chaque construction. Espérons-le, sans recourir à de honteux hackery.

Donc, ma question est double:

  1. Long shot: est-il un "Protocole Tampons plugin" pour Maven 2 que peut atteindre l'-dessus dans un automagic façon? Il y a un branche sur Google Code dont l'auteur semble avoir pris un coup à la mise en œuvre de ce plugin. Malheureusement, il n'a pas passé l'examen du code ou fusionné en protobuf tronc. L'état de ce plugin est donc inconnu.

  2. Sans doute plus réaliste: en l'absence d'un réel plugin, sinon comment pourrais-je aller sur le lancement d' protoc de mon Maven 2 build? Je suppose que je peut être en mesure de relier mon script shell dans un antrun invocation ou quelque chose de similaire.

Expériences personnelles sont les plus appréciés.

InformationsquelleAutor Max A. | 2009-10-16
  1. 44

    Vous trouverez quelques informations sur le plug-in disponible dans le Protocole de Tampons de référentiel dans la Protocol Buffers Compilateur Maven Plug-In fil sur le Protocole de Tampons groupe de discussion. Ma compréhension est qu'il est utilisable, mais manque de tests. Je donnerais un essai.

    Ou vous pouvez simplement utiliser le antrun plugin (snipet collé à partir du thread mentionné ci-dessus):

     <build>
   <plugins>
     <plugin>
       <artifactId>maven-antrun-plugin</artifactId>
       <executions>
         <execution>
           <id>generate-sources</id>
           <phase>generate-sources</phase>
           <configuration>
             <tasks>
               <mkdir dir="target/generated-sources"/>
               <exec executable="protoc">
                 <arg value="--java_out=target/generated-sources"/>
                 <arg value="src/main/protobuf/test.proto"/>
               </exec>
             </tasks>
             <sourceRoot>target/generated-sources</sourceRoot>
           </configuration>
           <goals>
             <goal>run</goal>
           </goals>
         </execution>
       </executions>
     </plugin>
   </plugins>
 </build>

 <dependencies>
   <dependency>
     <groupId>com.google.protobuf</groupId>
     <artifactId>protobuf-java</artifactId>
     <version>2.0.3</version>
   </dependency>
 </dependencies>
    • Absolument fascinante discussion, merci pour ce lien.
    • J'ai trouvé cette réponse satisfaisante, y compris pour une utilisation avec protobuf plugins qui ne semblent pas être pris en charge par le plugin maven. Cependant, je te recommande de ne pas utiliser sourceRoot qui est déprécié par maven.apache.org/plugins/maven-antrun-plugin/... et de s'appuyer sur build-helper-maven-plugin à la place (voir la section mojo.codehaus.org/build-helper-maven-plugin/usage.html). Ce qui était nécessaire pour faire mon projet de protocole et d'autres qui en dépendent se comporter correctement en m2eclipse.
    • pourriez-vous créer un pastie.org avec la pom nécessaire pour ne pas utiliser sourceRoot?
    • Assurez-vous. La partie pertinente ressemble à ceci pastie.org/1311036
    • Vous aussi vous voulez probablement ajouter failonerror à la <exec> tag afin que votre construction s'arrête si il y a une erreur dans votre proto fichier. I. e. <exec failonerror="true" executable="protoc">.
    • La dernière version 2.5.0. Pour travailler avec la version actuelle de protoc vous devez utiliser 2.5.0
    • Je suis assez nouveau à maven, donc cette question peut être un peu inutile, mais, si j'ai beaucoup de .proto fichiers, dois-je les ajouter un par un dans ce script, comme vous l'avez fait avec test.proto? Comme si j'ai deux proto fichiers, je vais écrire ça comme ça, hein? <arg value="target/proto/Empty.proto"/> <arg value="target/proto/ComponentState.proto"/>
    • Il ne fonctionne pas pour moi, et le produit est le suivant: [exec] /home/usr/workspace_runtime_x/x.messages/proto/ros/RosTime.proto: File does not reside within any path specified using --proto_path (or -I). You must specify a --proto_path which encompasses this file. Note that the proto_path must be an exact prefix of the .proto file names -- protoc is too dumb to figure out when two paths (e.g. absolute and relative) are equivalent (it's harder than you think)

    InformationsquelleAutor Pascal Thivent
  2. 23

    La accepté de répondre à m'a encouragé à obtenir de la Google-plugin fourni à travailler. J'ai fusionné la branche mentionné dans ma question dans une caisse de 2.2.0 code source, construit et installé/déployé le plug-in, et a été en mesure de l'utiliser dans mon projet comme suit:

      <build>
    <plugins>
      <plugin>
        <groupId>com.google.protobuf.tools</groupId>
        <artifactId>maven-protoc-plugin</artifactId>
        <version>0.0.1</version>
        <executions>
          <execution>
            <id>generate-sources</id>
            <goals>
              <goal>compile</goal>
            </goals>
            <phase>generate-sources</phase>
            <configuration>
              <protoSourceRoot>${basedir}/src/main/protobuf/</protoSourceRoot>
              <includes>
                <param>**/*.proto</param>
              </includes>
            </configuration>
          </execution>
        </executions>
        <configuration>
          <protocExecutable>/usr/local/bin/protoc</protocExecutable>
        </configuration>
      </plugin>
    </plugins>
  </build>

    Noter que j'ai changé le plugin de la version 0.0.1 (pas INSTANTANÉ), afin de le faire passer dans mon non-instantané tiers Nexus référentiel. YMMV. La vente à emporter est que ce plugin sera utilisable une fois qu'il n'est plus nécessaire de sauter à travers des cerceaux pour obtenir ce que ça va.

    • Merci pour les commentaires.
    • Merci de faire de ce plugin disponible dans Maven Central. Aussi, est-il possible d'appeler par programme protoc au lieu de chercher un exécutable? C'est une douleur pour générer protoc sur de nombreuses plateformes dont Mac OS X.
    InformationsquelleAutor Max A.
  3. 21

    La solution retenue n'est pas à l'échelle de plusieurs proto fichiers. Je devais venir avec mon propre:

    <build>
    <plugins>
        <plugin>
            <artifactId>maven-antrun-plugin</artifactId>
            <executions>
                <execution>
                    <id>compile-protoc</id>
                    <phase>generate-sources</phase>
                    <configuration>
                        <tasks>
                            <mkdir dir="${generated.sourceDirectory}" />
                            <path id="proto.path">
                                <fileset dir="src/main/proto">
                                    <include name="**/*.proto" />
                                </fileset>
                            </path>
                            <pathconvert pathsep=" " property="proto.files" refid="proto.path" />
                            <exec executable="protoc" failonerror="true">
                                <arg value="--java_out=${generated.sourceDirectory}" />
                                <arg value="-I${project.basedir}/src/main/proto" />
                                <arg line="${proto.files}" />
                            </exec>
                        </tasks>
                    </configuration>
                    <goals>
                        <goal>run</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
</build>
    • comment spécifier l'emplacement de protoc.exe fichier. mon build échoue, car il est impossible de localiser protoc. Est protoc fourni par le PB 2.4.1 dépendance ajouté à la pon.xml ?
    • Non, protoc est le protocole de tampon et d'un compilateur doit être installé sur la machine de la construction est en cours d'exécution sur et inclus dans la machine du chemin. Reportez-vous à code.google.com/apis/protocolbuffers/docs/proto.html#generating (en particulier la section sur la génération de vos classes) pour plus d'informations
    InformationsquelleAutor jsravn
  4. 10

    Il y a aussi de grands plugin par Igor Petruk nommé protobuf-maven-plugin. C'est dans le centre des pensions de maintenant et joue bien avec eclipse (m2e-1.1 est recommandé).

    • La documentation pour Igor plugin est ici. Si vous mettez votre .proto fichiers dans src/main/protobuf, vous aurez le résultat dans target/generated-sources/protobuf. Vous aurez toujours besoin de protoc sur votre PATH pour que cela fonctionne.
    InformationsquelleAutor morgwai
  5. 4

    Je viens de mettre à jour le plugin maven pour travailler avec 2.2.0 -- la mise à jour de pom sont attachés à la révision du code de bug.

    Voici les instructions pour construire le plugin vous-même:

    svn co http://protobuf.googlecode.com/svn/branches/maven-plugin/tools/maven-plugin
cd maven-plugin
wget -O pom.xml 'http://protobuf.googlecode.com/issues/attachment?aid=8860476605163151855&name=pom.xml'
mvn install

    Vous pouvez ensuite utiliser le maven config ci-dessus.

    InformationsquelleAutor
  6. 4

    J'ai juste essayé un moins officiel, mais très récente (v 0.1.7) fourchette de https://github.com/dtrott/maven-protoc-plugin et ça a très bien fonctionné, avec l'aimable autorisation de David Trott. Je l'ai testé avec un couple de Maven modules dont un contenait DTO style des messages et de l'autre un service selon eux. J'ai emprunté la configuration du plugin MaxA posté le 16 Oct '09, j'ai eu protoc sur mon CHEMIN et j'ai ajouté

    <temporaryProtoFileDirectory>${basedir}/target/temp</temporaryProtoFileDirectory>

    juste après

    <protocExecutable>protoc</protocExecutable>.

    Ce qui est vraiment bien c'est que tout ce que j'avais à faire est de déclarer une normale de la dépendance à partir du module de service sur la DTO module. Le plugin a été en mesure de résoudre proto fichiers de dépendances par trouver le proto fichiers qui sont emballés avec les DTO module d'extraction dans un répertoire temporaire et de l'aide lors de la génération de code pour le service. Et il a été assez intelligent pour ne pas compresser une deuxième copie de la DTO des cours avec le module de service.

    InformationsquelleAutor ndolgov
  7. 4

    Il y a un plugin maven pour protobuf. https://www.xolstice.org/protobuf-maven-plugin/usage.html

    La config minimale 

     <plugin>
    <groupId>org.xolstice.maven.plugins</groupId>
    <artifactId>protobuf-maven-plugin</artifactId>
    <version>0.5.0</version>
    <configuration>
      <protocExecutable>/usr/local/bin/protoc</protocExecutable>
    </configuration>
    <executions>
      <execution>
        <goals>
          <goal>compile</goal>
          <goal>test-compile</goal>
        </goals>
      </execution>
    </executions>
  </plugin>
    InformationsquelleAutor smartwjw
  8. 0

    Je pense que l'utilisation de antrun d'invoquer la non-Maven étapes est la solution communément acceptée.

    Vous pouvez également essayer les maven-exec-plugin.

    • J'ai deux problèmes avec l'aide de antrun: (1) Son objectif est de faciliter la migration en provenance ou l'intégration avec Ant. Je suis d'essayer d'atteindre aucun des deux. Ainsi, en l'utilisant dans ce cas, semblent presque comme une mauvaise utilisation. (2) je suis vraiment juste pour frayer un externe des processus du système d'exploitation. En tirant dans tous Ant juste pour qui est, à mon humble avis, exagéré. maven-exec-plugin sonne comme une cure de minceur et de choix plus approprié dans ce cas.
    • Je suis d'accord c'est exagéré, mais parfois, il peut offrir un moyen facile de faire de l'onu-Maven choses.
    • Le plus drôle, c'est que les gens de Google utiliser Maven pour construire le Java morceau de protobuf, donc il n'y a absolument rien de "non-Maven" au sujet de vouloir utiliser un plugin Maven pour compiler mon .proto sources. Je suis sûr que ce processus deviendra plus facile une fois qu'ils ont obtenu leur acte ensemble. Tout ce qui reste est vraiment d'obtenir ce plugin dans Google ou au référentiel central.
    InformationsquelleAutor matt b
  9. 0

    Je bifurquais du plugin de David Trott et avoir de la compilation de plusieurs langues, ce qui le rend beaucoup plus utile. Voir le projet github ici et un tutoriel sur l'intégration avec un maven build ici.

    InformationsquelleAutor Usman Ismail