Assertions em Java

Enfim, as Assertions servem para testar se o seu c�digo esta de acordo com as regras que deve seguir (vamos dar exemplos melhores a frente), sem precisar fazer laços enormes com �throw new� e mais outros recursos s� para testar se tudo est� certo. As Assertions s�o utilizadas SOMENTE e APENAS para o ambiente de desenvolvimento, quando o software for para produç�o, elas devem ser retiradas sem que o software seja afetado. Por isso ao implementar assert n�o deixe seu software �dependente� destes, de forma que depois voc� n�o consiga tirar sem mudar a l�gica do mesmo.

A sintaxe para uso de Assertions pode ser de duas formas:

assert Express�o�;
assert Express�o� : Express�o�;

Acontece que o assert sempre dever� ter um valor Verdadeiro, caso contr�rio ele levantar� uma exceç�o AssertionError. No primeiro caso de sintaxe � testado apenas se a express�o passada � True, caso contr�rio � �levantada� uma exceç�o, j� no segundo caso al�m da express�o principal, uma segunda express�o serve como mensagem para que o programador veja o que esta ocorrendo.

Usando Assertion na Pr�tica

Como sempre, vamos partir para a pr�tica e entender o uso dos Assertions, vamos utilizar exemplos da pr�pria documentaç�o da Oracle, para facilitar o entendimento.

Imagine a seguinte situaç�o: Voc� desenvolveu um software que calcula a velocidade de part�culas, e voc� sabe que essa velocidade deve ser menor que a velocidade da luz. Para efeito de conhecimento a velocidade da luz � aproximadamente: 300mil KM/s. Na listagem 1 vamos fazer um exemplo para testar se a velocidade da part�cula � menor que a velocidade da luz e parar a execuç�o caso isso seja falso.


package br.com.odontonew.bean;

public class CalculadorParticula {
	
	private static final Integer QUILOMETROS_POR_SEGUNDO = 0;
	private static final Integer METROS_POR_SEGUNDO = 1;
	private static final Integer VELOCIDADE_LUZ = 300000;
	
	/**
	 * @param args
	 * @throws  
	 */
	public static void main(String[] args) {
		
		//Em KM/s
		Integer velocidadeParticula = 
		retornarVelocidadeParticula(12, QUILOMETROS_POR_SEGUNDO);
		
		try{
			if (velocidadeParticula > VELOCIDADE_LUZ)			
				throw new Exception("Velocidade da Particula n�o pode 
				ser maior que a velocidade da Luz");	
		
		}catch(Exception e){
			e.printStackTrace();
		}
		

	}
	

}

Listagem 1. Testando velocidade da part�cula sem Assert

Um c�digo que consome muito espaço apenas para testar uma simples proposiç�o, que poder�amos simplificar em apenas 1 linha com assert. Afinal, se voc� parar para pensar a velocidade da part�cula tem que obrigatoriamente se menor que a velocidade da luz, e o usu�rio n�o precisa saber disso, o software apenas tem que certificar que o valor seja sempre exatamente menor que a velocidade da luz, por isso n�o podemos colocar o mesmo em produç�o se isso estiver errado, � uma regra de neg�cio.

Na listagem 2 vamos fazer a mesma comparaç�o, por�m usando assert, assim diminu�mos a complexidade do c�digo e facilitamos uma remoç�o para quando a aplicaç�o for para produç�o.


public class CalculadorParticula {
	
	private static final Integer QUILOMETROS_POR_SEGUNDO = 0;
	private static final Integer METROS_POR_SEGUNDO = 1;
	private static final Integer VELOCIDADE_LUZ = 300000;

	
	/**
	 * @param args
	 * @throws  
	 */
	public static void main(String[] args) {
		
		//Em KM/s
		Integer velocidadeParticula = retornarVelocidadeParticula(12, 
		QUILOMETROS_POR_SEGUNDO);
		
		assert(velocidadeParticula < VELOCIDADE_LUZ):
		"Velocidade da particula n�o pode ser maior que a velocidade da luz";	
		

	}
	

}

Listagem 2. Usando Assert

Caso seu assert n�o funcione, voc� deve ativ�-lo. Uma das formas de ativar � pelo Eclipse seguindo os passos abaixo, assim toda vez que voc� executar qualquer projeto, j� estar� ativo os assert.

Abra o Eclipse e v� em Window -> Preferences.
V� at� Java -> Installed JREs. Voc� deve selecionar o JRE que voc� utiliza e clicar em Editar (Edit).

Figura 1. Escolhendo a JRE

Digite �-ea� no campo �Default VM arguments�, que significa Enable Assertions.

Figura 2. Habilitando Assertions

Ap�s a configuraç�o acima, voc� poder� executar o c�digo do calculador de part�culas e ver� o assert funcionando. Voc� mesmo pode setar um valor a part�cula para testar o assert.

Regras Importantes

Antes de começar a usar assert tenha em mentes algumas regras que devem ser seguidas:

N�o use Assert no lugar do IF/ELSE, pois ele deve ser retirado quando o software for para produç�o.
O Assert n�o testa m�todos p�blicos, ou valores digitados diretamente pelo usu�rio, ou seja, passe vari�veis j� prontas para que ele possa testar.
E um dos mais importantes: Jamais faça seu software depender do assert, isso significa que o assert n�o pode causar efeitos colaterais ao seu software, voc� deve poder habilitar e desabilit�-lo sem nenhum problema. Veja na listagem 3 um forma errada de usar o assert.


assert names.remove(null);

Listagem 3. Usando Assert de forma errada

Errado pois voc� n�o deve, jamais, vincular parte do seu c�digo ao assert, o modo correto est� na listagem 4.


boolean nullsRemoved = names.remove(null);
assert nullsRemoved;  // Runs whether or not asserts are enabled

Listagem 4. Usando Assert de forma correta

Perceba no c�digo acima que se comentarmos a linha �assert nullsRemoved;� o c�digo continuar� funcionando da mesma forma, sem nenhum efeito colateral. S� colocamos o assert para certificar que o valor � o que desejamos, e que o software esta funcionando como desejamos, ao por em produç�o, comentaremos ou removemos essa linha.

Conclus�o

Assertivas ou Asserts � um recurso muito poderoso para aumentar a produtividade no desenvolvimento de sistemas, assim voc� n�o precisar� ficar debugando linhas e linhas de c�digo para descobrir 1 simples erro. Se utilizado da forma correta, com certeza ser� um forte aliado em grandes projetos.

Assertions em Java

Veja nesse artigo uma explicação detalhada do uso de Assertions em Java, que por muitas vezes confundem o programador que não sabe o que usar: IF/ELSE ou Assertions?

Usando Assertion na Pr�tica

Regras Importantes

Conclus�o

Artigos relacionados