Personalizando binários em Go com build tags

Introdução

No Go, um build tag, ou uma restrição de compilação, é um identificador adicionado a um pedaço de código que determina quando o arquivo deve ser incluído em um pacote durante o processo de build. Isso permite que você compile diferentes versões de seu aplicativo em Go a partir do mesmo código fonte e para alternar entre eles de maneira rápida e organizada. Muitos desenvolvedores usam os build tags (sinalizadores de compilação) para melhorar o fluxo de trabalho da compilação de aplicativos compatíveis entre plataformas, tais como os programas que necessitam de mudanças no código para explicar as variações entre diferentes sistemas operacionais. Os build tags também são usados para testes de integração, permitindo que você alterne rapidamente entre o código integrado e o código com um serviço fictício ou stub e para diferenciar os níveis dos conjuntos de recursos dentro de um aplicativo.

A título de exemplo, vamos considerar o problema dos diferentes conjuntos de recursos do cliente. Ao escrever alguns aplicativos, você pode querer controlar quais recursos incluir no binário, como um aplicativo que oferece níveis Free (Livre), Pro (Profissional) e Enterprise (Empresarial). À medida que o cliente aumenta seu nível de assinatura nesses aplicativos, mais recursos se tornam desbloqueados e disponíveis. Para resolver esse problema, você poderia manter projetos separados e tentar mantê-los em sincronia uns com os outros através do uso de instruções de import. Embora essa abordagem iria funcionar,com o tempo ela se tornaria entediante e propensa a erros. Uma abordagem alternativa seria usar os build tags (sinalizadores de compilação).

Neste artigo, você usará os build tags no Go para gerar diferentes binários executáveis que oferecem conjuntos de recursos Free, Pro e Enterprise de um aplicativo exemplo. Cada binário terá um conjunto diferente de recursos disponíveis, com a versão Free sendo a padrão.

Pré-requisitos

Para seguir o exemplo neste artigo, será necessário:

• Um espaço de trabalho em Go configurado de acordo com o artigo Como instalar o Go e configurar um ambiente de programação local.

Compilando a versão Free

Vamos começar compilando a versão Free do aplicativo, uma vez que ela será a versão padrão durante a execução do go build, sem quaisquer build tags. Mais tarde, usaremos os build tags para adicionar seletivamente outras partes ao nosso programa.

No diretório src, crie uma pasta com o nome do seu aplicativo. Este tutorial usará o nome app:

mkdir app

Mova para esta pasta:

cd app

Em seguida, crie um novo arquivo de texto, chamado main.go, no editor de texto de sua preferência:

nano main.go

Agora, vamos definir a versão Free do aplicativo. Adicione o conteúdo a seguir ao main.go:

package main

import "fmt"

var features = []string{
  "Free Feature #1",
  "Free Feature #2",
}

func main() {
  for _, f := range features {
    fmt.Println(">", f)
  }
}

Neste arquivo, criamos um programa que declara uma fatia chamada features, que contém duas strings que representam os recursos de nosso aplicativo Free. A função main() no aplicativo usa um loop for para o range (intervalo) dentro da fatia de features e depois imprime todos os recursos disponíveis na tela.

Salve e saia do arquivo. Agora que este arquivo está salvo, não precisaremos mais editá-lo pelo resto do artigo. Em vez disso, usaremos os build tags para alterar as características dos binários que vamos compilar a partir dele.

Compile e execute o programa:

go build
./app

Você receberá o seguinte resultado:

Output
> Free Feature #1
> Free Feature #2

O programa imprimiu nossos nossos dois recursos gratuitos, completando a versão Free do nosso aplicativo.

Até agora, você criou um aplicativo que tem um conjunto de características bem básicas. Em seguida, você irá criar uma maneira de adicionar mais recursos no aplicativo no momento da compilação.

Adicionando os recursos Pro com o go build

Até agora, evitamos fazer alterações no main.go, simulando um ambiente de produção comum no qual o código precisa ser adicionado, sem alterar e possivelmente quebrar o código principal. Como não podemos editar o arquivo main.go, precisaremos usar outro mecanismo para injetar mais recursos na fatia de features usando os build tags.

Vamos criar um novo arquivo chamado pro.go que usará uma função init() para acrescentar mais recursos na fatia de features:

nano pro.go

Assim que o editor abrir o arquivo, adicione as seguintes linhas:

package main

func init() {
  features = append(features,
    "Pro Feature #1",
    "Pro Feature #2",
  )
}

Neste código, usamos o init() para executar o código antes da função main() do nosso aplicativo, seguido pelo append() para adicionar os recursos Pro à fatia features. Salve e saia do arquivo.

Compile e execute o aplicativo usando o go build:

go build

Como agora existem dois arquivos em nosso diretório atual (pro.go e main.go), o go build criará um binário de ambos. Execute este binário:

./app

Isso dará a você o seguinte conjunto de recursos:

Output
> Free Feature #1
> Free Feature #2
> Pro Feature #1
> Pro Feature #2

Agora, o aplicativo agora inclui tanto os recursos da versão Pro como os recursos da Free. No entanto, isso não é desejável: uma vez que não há distinção entre as versões, a versão Free agora inclui os recursos que deveriam estar disponíveis apenas na versão Pro. Para corrigir isso, você poderia incluir mais códigos para gerenciar os diferentes níveis do aplicativo ou usar os build tags para dizer à cadeia de ferramentas Go quais arquivos .go compilar e quais ignorar. Vamos adicionar os build tags no próximo passo.

Adicionando os build tags

Agora, é possível usar os build tags para distinguir a versão Pro do seu aplicativo da versão Free.

Vamos começar examinando como se parece um build tag:

// +build tag_name

Ao colocar essa linha de código como a primeira linha do seu pacote e substituir o tag_name pelo nome do seu build tag, você irá sinalizar esse pacote como um código que pode ser incluído seletivamente no binário final. Vamos ver como isso funciona na prática, adicionando um build tag ao arquivo pro.go para dizer ao comando go build ignorá-lo, a menos que o tag seja especificado. Abra o arquivo no seu editor de texto:

nano pro.go

Então, adicione a linha destacada a seguir:

// +build pro

package main

func init() {
  features = append(features,
    "Pro Feature #1",
    "Pro Feature #2",
  )
}

No topo do arquivo pro.go, adicionamos // +build pro, seguido de uma nova linha em branco. Esta essa nova linha no final é necessária, caso contrário o Go interpreta o comando como um comentário. As declarações de build tag também devem estar na parte superior do arquivo .go. Nada, nem mesmo comentários, pode estar acima dos build tags.

A declaração +build diz ao comando go build que este não é um comentário, mas sim um build tag. A segunda parte é o sinalizador pro. Ao adicionar esse sinalizador na parte superior do arquivo pro.go, o comando go build agora só incluirá o arquivo pro.go se o sinalizador pro estiver presente.

Compile e execute o aplicativo novamente:

go build
./app

Você receberá o seguinte resultado:

Output
> Free Feature #1
> Free Feature #2

Como o arquivo pro.go exige que um sinalizador pro esteja presente, o arquivo é ignorado e o aplicativo compila sem ele.

Ao executar o comando go build, podemos usar o sinalizador -tags para incluir, por condição, o código na fonte compilada, adicionando o sinalizador propriamente dito como um argumento. Vamos fazer isso para o sinalizador pro:

go build -tags pro

Isso irá mostrar o seguinte:

Output
> Free Feature #1
> Free Feature #2
> Pro Feature #1
> Pro Feature #2

Agora, vamos obter recursos extra quando compilarmos o aplicativo usando build tag pro.

Não haverá problemas nisso caso houver apenas duas versões, mas as coisas ficam complicadas quando você adicionar mais sinalizadores. Para adicionar na versão Enterprise de nosso aplicativo no próximo passo, usaremos vários build tags juntos com a lógica booleana.

Lógica booleana com o build tag

Quando há vários build tags em um pacote Go, eles interagem entre si usando a Lógica booleana. Para demonstrar isso, adicionaremos o nível Enterprise do nosso aplicativo usando os sinalizadores pro e enterprise.

Para compilar um binário Enterprise, precisaremos incluir os recursos padrão, os recursos de nível Pro e um novo conjunto de recursos para o Enterprise. Primeiro, abra um editor e crie um novo arquivo, o enterprise.go, que adicionará os novos recursos de Enterprise:

nano enterprise.go

O conteúdo do enterprise.go ficará quase idêntico ao pro.go, mas terá novos recursos. Adicione as seguintes linhas ao arquivo:

package main

func init() {
  features = append(features,
    "Enterprise Feature #1",
    "Enterprise Feature #2",
  )
}

Salve e saia do arquivo.

No momento, o arquivo enterprise.go não possui nenhum build tag e, como você aprendeu ao adicionar recursos no pro.go, isto significa que esses recursos serão adicionados à versão Free durante a execução do go.build. Para o pro.go, você adicionou // + build pro e uma nova linha na parte superior do arquivo para dizer ao go build que ele deve ser incluído somente quando -tags pro for usada. Nessa situação, você precisa apenas de um build tag para atingir o objetivo. No entanto, ao adicionar os novos recursos de Enterprise, você primeiro deve ter os recursos Pro.

Vamos primeiro adicionar o suporte para build tag pro ao enterprise.go. Abra o arquivo com seu editor de texto:

nano enterprise.go

Em seguida, adicione o build tag antes da declaração package main e certifique-se de incluir uma nova linha após o build tag:

// +build pro

package main

func init() {
  features = append(features,
    "Enterprise Feature #1",
    "Enterprise Feature #2",
  )
}

Salve e saia do arquivo.

Compile e execute o aplicativo sem quaisquer sinalizadores:

go build
./app

Você receberá o seguinte resultado:

Output
> Free Feature #1
> Free Feature #2

Os recursos Enterprise não vão mais aparecer na versão Free. Agora, vamos adicionar o build tag pro, compilar e executar o aplicativo novamente:

go build -tags pro
./app

Você receberá o seguinte resultado:

Output
> Free Feature #1
> Free Feature #2
> Enterprise Feature #1
> Enterprise Feature #2
> Pro Feature #1
> Pro Feature #2

Isso ainda não é exatamente o que precisamos: os recursos da versão Enterprise agora aparecem quando tentamos compilar a versão Pro. Para resolver isso, precisamos usar outro build tag. No entanto, ao contrário do sinalizador pro, precisamos agora garantir que os recursos pro e enterprise estejam disponíveis.

O sistema de compilação Go é responsável por essa situação, permitindo o uso de uma lógica básica booleana no sistema de build tags.

Vamos abrir o enterprise.go novamente:

nano enterprise.go

Adicione outro build tag, enterprise, na mesma linha do identificador pro:

// +build pro enterprise

package main

func init() {
  features = append(features,
    "Enterprise Feature #1",
    "Enterprise Feature #2",
  )
}

Salve e feche o arquivo.

Agora, vamos compilar e executar o aplicativo com o novo build tag enterprise.

go build -tags enterprise
./app

Isso resultará no seguinte:

Output
> Free Feature #1
> Free Feature #2
> Enterprise Feature #1
> Enterprise Feature #2

Agora, perdemos os recursos Pro. Isso acontece porque quando colocarmos vários build tags na mesma linha em um arquivo .go, o go build os interpreta como se estivesse usando uma lógica OR. Com a adição da linha // + build pro enterprise, o arquivo enterprise.go será compilado caso tanto o build tag pro quanto o enterprise estiverem presentes. Em vez disso, precisamos configurar os build tags corretamente para exigir ambos e usar a lógica AND.

Em vez de colocar ambos sinalizadores na mesma linha, se os colocarmos em linhas separadas, o go build irá, então, interpretar esses identificadores usando a lógica AND.

Abra o enterprise.go novamente e vamos separar os build tags em várias linhas.

// +build pro
// +build enterprise

package main

func init() {
  features = append(features,
    "Enterprise Feature #1",
    "Enterprise Feature #2",
  )
}

Agora, compile e execute o aplicativo com o novo build tag enterprise.

go build -tags enterprise
./app

Você receberá o seguinte resultado:

Output
> Free Feature #1
> Free Feature #2

Ainda não chegamos lá: como uma instrução AND exige que ambos os elementos sejam considerados true, precisamos usar os build tags pro e enterprise juntos.

Vamos tentar novamente:

go build -tags "enterprise pro"
./app

Você receberá o seguinte resultado:

Output
> Free Feature #1
> Free Feature #2
> Enterprise Feature #1
> Enterprise Feature #2
> Pro Feature #1
> Pro Feature #2

Agora, nosso aplicativo pode ser compilado a partir da mesma árvore de várias maneiras, desbloqueando os recursos do aplicativo corretamente.

Neste exemplo, usamos um novo sinalizador // + build para significar uma lógica AND, mas existem maneiras alternativas de representar a lógica booleana com os build tags. A tabela a seguir contém alguns exemplos de formatação sintática para build tags, junto com suas equivalentes booleanas:

Conclusão

Neste tutorial, você usou build tags para permitir que você controle qual de seus códigos será compilado no binário. Primeiro, você declarou os build tags e os usou com o go build; depois, combinou vários identificadores com a lógica booleana. Em seguida, você compilou um programa que representava os diferentes conjuntos de recursos de uma versão Free, Pro e Enterprise, mostrando o poderoso nível de controle sobre o seu projeto que os build tags podem dar a você.

Se quiser aprender mais sobre os build tags, consulte a documentação do Golang sobre o assunto, ou continue a explorar nossa série de artigos sobre Como codificar em Go.