Eu vivi em ambos e, embora ambos sejam ótimos, prefiro Madrid ao Barcelona. É uma questão de gosto pessoal.
Se você está apenas à procura de vida noturna, discotecas, etc ambos têm muito a oferecer com ótimos lugares para ir. A diferença é que o Barcelona é mais voltado para turistas com algumas discotecas na praia que estão cheias de turistas.
A praia é outra coisa que pode fazer você reconsiderar qual cidade você quer visitar.
Se você é mais culturalmente inclinado eu preferiria Madrid. Madri é a capital da Espanha há alguns séculos e isso faz uma grande diferença.
Apesar de Barcelona ter ótimos museus (MNAC, Picasso, ...), Madri tem três museus incríveis a uma distância a pé um do outro (El Prado, Thyssen-Bornemisza e Reina Sofía), além de muitos outros museus que fazem dele, na minha opinião, um deve ver a cidade.
Além disso, tendo sido a capital da Espanha por muitos anos, tem alguns belos edifícios (principalmente neoclássicos) feitos para os monarcas (Palacio Real, Plaza Mayor, ...). Por outro lado, Barcelona é famosa por sua arquitetura modernista (especialmente todos os edifícios de Gaudí).
Então, como você pode ver, chega-se a uma questão de gosto pessoal. Dependendo do que você quer, você pode preferir uma cidade sobre a outra, mas ambas são definitivamente dignas de serem vistas.